github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 01:38:56 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS][OAS] Add Fleet APIs (#190571)

Browse source
This commit is contained in:
Lisa Cawley 2024-08-15 10:49:58 -07:00 • committed by GitHub
parent c00a06164a
commit 444b8d010e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
65 changed files with 12571 additions and 236 deletions
Download patch file Download diff file Expand all files Collapse all files

4
oas_docs/.spectral.yaml
View file

@ -72,13 +72,13 @@ rules:
message: 'Each operation should have a summary'
severity: error
recommended: true
given: $.paths[*][*]
given: $.paths[*][get,put,post,delete,options,head,patch,trace]
then:
field: summary
function: defined
operation-summary-length:
description: Operation summary should be between 5 and 45 characters
given: '$.paths[*][*]'
given: '$.paths[*][get,put,post,delete,options,head,patch,trace]'
then:
field: summary
function: length

6138
oas_docs/output/kibana.serverless.yaml
View file

File diff suppressed because it is too large Load diff

6113
oas_docs/output/kibana.yaml
View file

File diff suppressed because it is too large Load diff

2
oas_docs/overlays/kibana.overlays.serverless.yaml
View file

@ -34,7 +34,7 @@ actions:
security:
- apiKeyAuth: []
# Mark all operations as beta
- target: '$.paths[*][*]'
- target: "$.paths[*]['get','put','post','delete','options','head','patch','trace']"
description: Add x-beta
update:
x-beta: true

1
oas_docs/scripts/merge_ess_oas.js
View file

@ -19,6 +19,7 @@ const { REPO_ROOT } = require('@kbn/repo-info');
`${REPO_ROOT}/src/plugins/data_views/docs/openapi/bundled.yaml`,
`${REPO_ROOT}/x-pack/plugins/ml/common/openapi/ml_apis.yaml`,
`${REPO_ROOT}/packages/core/saved-objects/docs/openapi/bundled.yaml`,
`${REPO_ROOT}/x-pack/plugins/fleet/common/openapi/bundled.yaml`,
// Observability Solution
`${REPO_ROOT}/x-pack/plugins/observability_solution/apm/docs/openapi/apm.yaml`,

1
oas_docs/scripts/merge_ess_oas_staging.js
View file

@ -19,6 +19,7 @@ const { REPO_ROOT } = require('@kbn/repo-info');
`${REPO_ROOT}/src/plugins/data_views/docs/openapi/bundled.yaml`,
`${REPO_ROOT}/x-pack/plugins/ml/common/openapi/ml_apis.yaml`,
`${REPO_ROOT}/packages/core/saved-objects/docs/openapi/bundled.yaml`,
`${REPO_ROOT}/x-pack/plugins/fleet/common/openapi/bundled.yaml`,
// Observability Solution
`${REPO_ROOT}/x-pack/plugins/observability_solution/apm/docs/openapi/apm.yaml`,

1
oas_docs/scripts/merge_serverless_oas.js
View file

@ -18,6 +18,7 @@ const { REPO_ROOT } = require('@kbn/repo-info');
`${REPO_ROOT}/src/plugins/data_views/docs/openapi/bundled.yaml`,
`${REPO_ROOT}/x-pack/plugins/ml/common/openapi/ml_apis_serverless.yaml`,
`${REPO_ROOT}/packages/core/saved-objects/docs/openapi/bundled_serverless.yaml`,
`${REPO_ROOT}/x-pack/plugins/fleet/common/openapi/bundled.yaml`,
// Observability Solution
`${REPO_ROOT}/x-pack/plugins/observability_solution/apm/docs/openapi/apm.yaml`,

1
oas_docs/scripts/merge_serverless_oas_staging.js
View file

@ -18,6 +18,7 @@ const { REPO_ROOT } = require('@kbn/repo-info');
`${REPO_ROOT}/src/plugins/data_views/docs/openapi/bundled.yaml`,
`${REPO_ROOT}/x-pack/plugins/ml/common/openapi/ml_apis_serverless.yaml`,
`${REPO_ROOT}/packages/core/saved-objects/docs/openapi/bundled_serverless.yaml`,
`${REPO_ROOT}/x-pack/plugins/fleet/common/openapi/bundled.yaml`,
// Observability Solution
`${REPO_ROOT}/x-pack/plugins/observability_solution/apm/docs/openapi/apm.yaml`,

203
x-pack/plugins/fleet/common/openapi/bundled.json
View file

@ -1,6 +1,55 @@
{
"openapi": "3.0.0",
"tags": [],
"tags": [
{
"name": "Data streams"
},
{
"name": "Elastic Agents"
},
{
"name": "Elastic Agent actions"
},
{
"name": "Elastic Agent binary download sources"
},
{
"name": "Elastic Agent policies"
},
{
"name": "Elastic Agent status"
},
{
"name": "Elastic Package Manager (EPM)"
},
{
"name": "Fleet enrollment API keys"
},
{
"name": "Fleet internals"
},
{
"name": "Fleet Server hosts"
},
{
"name": "Fleet Kubernetes"
},
{
"name": "Fleet outputs"
},
{
"name": "Fleet package policies"
},
{
"name": "Fleet proxies"
},
{
"name": "Fleet service tokens"
},
{
"name": "Fleet uninstall tokens"
}
],
"info": {
"title": "Fleet",
"description": "OpenAPI schema for Fleet API endpoints",
@ -243,7 +292,7 @@
"post": {
"summary": "Create service token",
"tags": [
"Service tokens"
"Fleet service tokens"
],
"responses": {
"200": {
@ -281,7 +330,7 @@
"post": {
"summary": "Create service token",
"tags": [
"Service tokens"
"Fleet service tokens"
],
"responses": {
"200": {
@ -1649,7 +1698,7 @@
"get": {
"summary": "Get agent setup info",
"tags": [
"Agents"
"Elastic Agents"
],
"responses": {
"200": {
@ -1676,7 +1725,7 @@
"post": {
"summary": "Initiate agent setup",
"tags": [
"Agents"
"Elastic Agents"
],
"operationId": "setup-agents",
"responses": {
@ -1726,7 +1775,7 @@
"get": {
"summary": "Get agent status summary",
"tags": [
"Agent status"
"Elastic Agent status"
],
"responses": {
"200": {
@ -1797,7 +1846,7 @@
"get": {
"summary": "Get agent status summary",
"tags": [
"Agent status"
"Elastic Agent status"
],
"responses": {
"200": {
@ -1888,7 +1937,7 @@
"get": {
"summary": "Get incoming agent data",
"tags": [
"Agent status"
"Elastic Agent status"
],
"responses": {
"200": {
@ -1941,7 +1990,7 @@
"get": {
"summary": "List agents",
"tags": [
"Agents"
"Elastic Agents"
],
"responses": {
"200": {
@ -2002,7 +2051,7 @@
"post": {
"summary": "List agents by action ids",
"tags": [
"Agents"
"Elastic Agents"
],
"responses": {
"200": {
@ -2052,7 +2101,7 @@
"post": {
"summary": "Bulk upgrade agents",
"tags": [
"Agents"
"Elastic Agents"
],
"responses": {
"200": {
@ -2106,7 +2155,7 @@
"get": {
"summary": "Get agent action status",
"tags": [
"Agent actions"
"Elastic Agent actions"
],
"parameters": [
{
@ -2276,7 +2325,7 @@
"get": {
"summary": "Get agent by ID",
"tags": [
"Agents"
"Elastic Agents"
],
"responses": {
"200": {
@ -2311,7 +2360,7 @@
"put": {
"summary": "Update agent by ID",
"tags": [
"Agents"
"Elastic Agents"
],
"responses": {
"200": {
@ -2367,7 +2416,7 @@
"delete": {
"summary": "Delete agent by ID",
"tags": [
"Agents"
"Elastic Agents"
],
"responses": {
"200": {
@ -2417,7 +2466,7 @@
"post": {
"summary": "Create agent action",
"tags": [
"Agent actions"
"Elastic Agent actions"
],
"responses": {
"200": {
@ -2493,7 +2542,7 @@
"post": {
"summary": "Cancel agent action",
"tags": [
"Agent actions"
"Elastic Agent actions"
],
"responses": {
"200": {
@ -2545,7 +2594,7 @@
"get": {
"summary": "Get file uploaded by agent",
"tags": [
"Agents"
"Elastic Agents"
],
"responses": {
"200": {
@ -2593,7 +2642,7 @@
"delete": {
"summary": "Delete file uploaded by agent",
"tags": [
"Agents"
"Elastic Agents"
],
"responses": {
"200": {
@ -2640,7 +2689,7 @@
"post": {
"summary": "Reassign agent",
"tags": [
"Agents"
"Elastic Agents"
],
"responses": {
"200": {
@ -2685,7 +2734,7 @@
"put": {
"summary": "Reassign agent",
"tags": [
"Agents"
"Elastic Agents"
],
"responses": {
"200": {
@ -2743,7 +2792,7 @@
"post": {
"summary": "Unenroll agent",
"tags": [
"Agents"
"Elastic Agents"
],
"responses": {
"200": {
@ -2820,7 +2869,7 @@
"post": {
"summary": "Upgrade agent",
"tags": [
"Agents"
"Elastic Agents"
],
"responses": {
"200": {
@ -2869,7 +2918,7 @@
"get": {
"summary": "List agent uploads",
"tags": [
"Agents"
"Elastic Agents"
],
"responses": {
"200": {
@ -2906,7 +2955,7 @@
"post": {
"summary": "Bulk reassign agents",
"tags": [
"Agents"
"Elastic Agents"
],
"responses": {
"200": {
@ -2978,7 +3027,7 @@
"post": {
"summary": "Bulk unenroll agents",
"tags": [
"Agents"
"Elastic Agents"
],
"responses": {
"200": {
@ -3061,7 +3110,7 @@
"post": {
"summary": "Bulk update agent tags",
"tags": [
"Agents"
"Elastic Agents"
],
"responses": {
"200": {
@ -3151,7 +3200,7 @@
"get": {
"summary": "List agent tags",
"tags": [
"Agents"
"Elastic Agents"
],
"responses": {
"200": {
@ -3185,7 +3234,7 @@
"post": {
"summary": "Request agent diagnostics",
"tags": [
"Agents"
"Elastic Agents"
],
"requestBody": {
"content": {
@ -3243,7 +3292,7 @@
"post": {
"summary": "Bulk request diagnostics from agents",
"tags": [
"Agents"
"Elastic Agents"
],
"responses": {
"200": {
@ -3325,7 +3374,7 @@
"get": {
"summary": "List agent policies",
"tags": [
"Agent policies"
"Elastic Agent policies"
],
"responses": {
"200": {
@ -3398,7 +3447,7 @@
"post": {
"summary": "Create agent policy",
"tags": [
"Agent policies"
"Elastic Agent policies"
],
"responses": {
"200": {
@ -3452,7 +3501,7 @@
"get": {
"summary": "Get agent policy by ID",
"tags": [
"Agent policies"
"Elastic Agent policies"
],
"responses": {
"200": {
@ -3484,7 +3533,7 @@
"put": {
"summary": "Update agent policy by ID",
"tags": [
"Agent policies"
"Elastic Agent policies"
],
"responses": {
"200": {
@ -3540,7 +3589,7 @@
"post": {
"summary": "Copy agent policy by ID",
"tags": [
"Agent policies"
"Elastic Agent policies"
],
"operationId": "agent-policy-copy",
"parameters": [
@ -3598,7 +3647,7 @@
"get": {
"summary": "Get full agent policy by ID",
"tags": [
"Agent policies"
"Elastic Agent policies"
],
"operationId": "agent-policy-full",
"responses": {
@ -3668,7 +3717,7 @@
"get": {
"summary": "Download agent policy by ID",
"tags": [
"Agent policies"
"Elastic Agent policies"
],
"operationId": "agent-policy-download",
"responses": {
@ -3731,7 +3780,7 @@
"post": {
"summary": "Bulk get agent policies",
"tags": [
"Agent policies"
"Elastic Agent policies"
],
"requestBody": {
"content": {
@ -3796,7 +3845,7 @@
"post": {
"summary": "Delete agent policy by ID",
"tags": [
"Agent policies"
"Elastic Agent policies"
],
"operationId": "delete-agent-policy",
"responses": {
@ -3892,7 +3941,7 @@
"get": {
"summary": "List enrollment API keys",
"tags": [
"Enrollment API keys"
"Fleet enrollment API keys"
],
"responses": {
"200": {
@ -3946,7 +3995,7 @@
"post": {
"summary": "Create enrollment API key",
"tags": [
"Enrollment API keys"
"Fleet enrollment API keys"
],
"responses": {
"200": {
@ -3997,7 +4046,7 @@
"get": {
"summary": "Get enrollment API key by ID",
"tags": [
"Enrollment API keys"
"Fleet enrollment API keys"
],
"responses": {
"200": {
@ -4028,7 +4077,7 @@
"delete": {
"summary": "Delete enrollment API key by ID",
"tags": [
"Enrollment API keys"
"Fleet enrollment API keys"
],
"responses": {
"200": {
@ -4069,7 +4118,7 @@
"get": {
"summary": "List enrollment API keys",
"tags": [
"Enrollment API keys"
"Fleet enrollment API keys"
],
"responses": {
"200": {
@ -4122,7 +4171,7 @@
"post": {
"summary": "Create enrollment API key",
"tags": [
"Enrollment API keys"
"Fleet enrollment API keys"
],
"responses": {
"200": {
@ -4172,7 +4221,7 @@
"get": {
"summary": "Get enrollment API key by ID",
"tags": [
"Enrollment API keys"
"Fleet enrollment API keys"
],
"responses": {
"200": {
@ -4202,7 +4251,7 @@
"delete": {
"summary": "Delete enrollment API key by ID",
"tags": [
"Enrollment API keys"
"Fleet enrollment API keys"
],
"responses": {
"200": {
@ -4242,7 +4291,7 @@
"get": {
"summary": "List package policies",
"tags": [
"Package policies"
"Fleet package policies"
],
"responses": {
"200": {
@ -4300,7 +4349,7 @@
"post": {
"summary": "Create package policy",
"tags": [
"Package policies"
"Fleet package policies"
],
"operationId": "create-package-policy",
"responses": {
@ -4353,7 +4402,7 @@
"post": {
"summary": "Bulk get package policies",
"tags": [
"Package policies"
"Fleet package policies"
],
"requestBody": {
"content": {
@ -4418,7 +4467,7 @@
"post": {
"summary": "Delete package policy",
"tags": [
"Package policies"
"Fleet package policies"
],
"operationId": "post-delete-package-policy",
"requestBody": {
@ -4488,7 +4537,7 @@
"post": {
"summary": "Upgrade package policy to a newer package version",
"tags": [
"Package policies"
"Fleet package policies"
],
"operationId": "upgrade-package-policy",
"requestBody": {
@ -4553,7 +4602,7 @@
"post": {
"summary": "Dry run package policy upgrade",
"tags": [
"Package policies"
"Fleet package policies"
],
"operationId": "upgrade-package-policy-dry-run",
"requestBody": {
@ -4627,7 +4676,7 @@
"get": {
"summary": "Get package policy by ID",
"tags": [
"Package policies"
"Fleet package policies"
],
"responses": {
"200": {
@ -4662,7 +4711,7 @@
"put": {
"summary": "Update package policy by ID",
"tags": [
"Package policies"
"Fleet package policies"
],
"operationId": "update-package-policy",
"requestBody": {
@ -4713,7 +4762,7 @@
"delete": {
"summary": "Delete package policy by ID",
"tags": [
"Package policies"
"Fleet package policies"
],
"operationId": "delete-package-policy",
"responses": {
@ -4754,7 +4803,7 @@
"get": {
"summary": "List outputs",
"tags": [
"Outputs"
"Fleet outputs"
],
"responses": {
"200": {
@ -4793,7 +4842,7 @@
"post": {
"summary": "Create output",
"tags": [
"Outputs"
"Fleet outputs"
],
"responses": {
"200": {
@ -4832,7 +4881,7 @@
"get": {
"summary": "Get output by ID",
"tags": [
"Outputs"
"Fleet outputs"
],
"responses": {
"200": {
@ -4869,7 +4918,7 @@
"delete": {
"summary": "Delete output by ID",
"tags": [
"Outputs"
"Fleet outputs"
],
"operationId": "delete-output",
"responses": {
@ -4904,7 +4953,7 @@
"put": {
"summary": "Update output by ID",
"tags": [
"Outputs"
"Fleet outputs"
],
"operationId": "update-output",
"requestBody": {
@ -4947,7 +4996,7 @@
"get": {
"summary": "Get latest output health",
"tags": [
"Outputs"
"Fleet outputs"
],
"responses": {
"200": {
@ -4995,7 +5044,7 @@
"post": {
"summary": "Generate Logstash API key",
"tags": [
"Outputs"
"Fleet outputs"
],
"responses": {
"200": {
@ -5029,7 +5078,7 @@
"get": {
"summary": "List agent binary download sources",
"tags": [
"Agent binary download sources"
"Elastic Agent binary download sources"
],
"responses": {
"200": {
@ -5068,7 +5117,7 @@
"post": {
"summary": "Create agent binary download source",
"tags": [
"Agent binary download sources"
"Elastic Agent binary download sources"
],
"responses": {
"200": {
@ -5125,7 +5174,7 @@
"get": {
"summary": "Get agent binary download source by ID",
"tags": [
"Agent binary download sources"
"Elastic Agent binary download sources"
],
"responses": {
"200": {
@ -5165,7 +5214,7 @@
"delete": {
"summary": "Delete agent binary download source by ID",
"tags": [
"Agent binary download sources"
"Elastic Agent binary download sources"
],
"operationId": "delete-download-source",
"responses": {
@ -5200,7 +5249,7 @@
"put": {
"summary": "Update agent binary download source by ID",
"tags": [
"Agent binary download sources"
"Elastic Agent binary download sources"
],
"operationId": "update-download-source",
"requestBody": {
@ -5510,7 +5559,7 @@
"get": {
"summary": "List proxies",
"tags": [
"Proxies"
"Fleet proxies"
],
"responses": {
"200": {
@ -5549,7 +5598,7 @@
"post": {
"summary": "Create proxy",
"tags": [
"Proxies"
"Fleet proxies"
],
"responses": {
"200": {
@ -5614,7 +5663,7 @@
"get": {
"summary": "Get proxy by ID",
"tags": [
"Proxies"
"Fleet proxies"
],
"responses": {
"200": {
@ -5654,7 +5703,7 @@
"delete": {
"summary": "Delete proxy by ID",
"tags": [
"Proxies"
"Fleet proxies"
],
"operationId": "delete-fleet-proxies",
"responses": {
@ -5689,7 +5738,7 @@
"put": {
"summary": "Update proxy by ID",
"tags": [
"Proxies"
"Fleet proxies"
],
"operationId": "update-fleet-proxies",
"requestBody": {
@ -5755,7 +5804,7 @@
"get": {
"summary": "Get full K8s agent manifest",
"tags": [
"Kubernetes"
"Fleet Kubernetes"
],
"responses": {
"200": {
@ -5810,7 +5859,7 @@
"get": {
"summary": "List metadata for latest uninstall tokens per agent policy",
"tags": [
"Uninstall tokens"
"Fleet uninstall tokens"
],
"responses": {
"200": {
@ -5898,7 +5947,7 @@
"get": {
"summary": "Get one decrypted uninstall token by its ID",
"tags": [
"Uninstall tokens"
"Fleet uninstall tokens"
],
"responses": {
"200": {
@ -7054,7 +7103,7 @@
},
"agent_status": {
"type": "string",
"title": "Agent status",
"title": "Elastic Agent status",
"enum": [
"offline",
"error",

170
x-pack/plugins/fleet/common/openapi/bundled.yaml
View file

@ -1,5 +1,21 @@
openapi: 3.0.0
tags: []
tags:
- name: Data streams
- name: Elastic Agents
- name: Elastic Agent actions
- name: Elastic Agent binary download sources
- name: Elastic Agent policies
- name: Elastic Agent status
- name: Elastic Package Manager (EPM)
- name: Fleet enrollment API keys
- name: Fleet internals
- name: Fleet Server hosts
- name: Fleet Kubernetes
- name: Fleet outputs
- name: Fleet package policies
- name: Fleet proxies
- name: Fleet service tokens
- name: Fleet uninstall tokens
info:
title: Fleet
description: OpenAPI schema for Fleet API endpoints
@ -155,7 +171,7 @@ paths:
post:
summary: Create service token
tags:
- Service tokens
- Fleet service tokens
responses:
'200':
description: OK
@ -178,7 +194,7 @@ paths:
post:
summary: Create service token
tags:
- Service tokens
- Fleet service tokens
responses:
'200':
description: OK
@ -1044,7 +1060,7 @@ paths:
get:
summary: Get agent setup info
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK
@ -1060,7 +1076,7 @@ paths:
post:
summary: Initiate agent setup
tags:
- Agents
- Elastic Agents
operationId: setup-agents
responses:
'200':
@ -1090,7 +1106,7 @@ paths:
get:
summary: Get agent status summary
tags:
- Agent status
- Elastic Agent status
responses:
'200':
description: OK
@ -1138,7 +1154,7 @@ paths:
get:
summary: Get agent status summary
tags:
- Agent status
- Elastic Agent status
responses:
'200':
description: OK
@ -1200,7 +1216,7 @@ paths:
get:
summary: Get incoming agent data
tags:
- Agent status
- Elastic Agent status
responses:
'200':
description: OK
@ -1233,7 +1249,7 @@ paths:
get:
summary: List agents
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK
@ -1263,7 +1279,7 @@ paths:
post:
summary: List agents by action ids
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK
@ -1293,7 +1309,7 @@ paths:
post:
summary: Bulk upgrade agents
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK
@ -1327,7 +1343,7 @@ paths:
get:
summary: Get agent action status
tags:
- Agent actions
- Elastic Agent actions
parameters:
- $ref: '#/components/parameters/page_size'
- $ref: '#/components/parameters/page_index'
@ -1448,7 +1464,7 @@ paths:
get:
summary: Get agent by ID
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK
@ -1469,7 +1485,7 @@ paths:
put:
summary: Update agent by ID
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK
@ -1503,7 +1519,7 @@ paths:
delete:
summary: Delete agent by ID
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK
@ -1533,7 +1549,7 @@ paths:
post:
summary: Create agent action
tags:
- Agent actions
- Elastic Agent actions
responses:
'200':
description: OK
@ -1579,7 +1595,7 @@ paths:
post:
summary: Cancel agent action
tags:
- Agent actions
- Elastic Agent actions
responses:
'200':
description: OK
@ -1610,7 +1626,7 @@ paths:
get:
summary: Get file uploaded by agent
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK
@ -1640,7 +1656,7 @@ paths:
delete:
summary: Delete file uploaded by agent
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK
@ -1669,7 +1685,7 @@ paths:
post:
summary: Reassign agent
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK
@ -1696,7 +1712,7 @@ paths:
put:
summary: Reassign agent
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK
@ -1731,7 +1747,7 @@ paths:
post:
summary: Unenroll agent
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK
@ -1777,7 +1793,7 @@ paths:
post:
summary: Upgrade agent
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK
@ -1806,7 +1822,7 @@ paths:
get:
summary: List agent uploads
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK
@ -1829,7 +1845,7 @@ paths:
post:
summary: Bulk reassign agents
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK
@ -1872,7 +1888,7 @@ paths:
post:
summary: Bulk unenroll agents
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK
@ -1925,7 +1941,7 @@ paths:
post:
summary: Bulk update agent tags
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK
@ -1979,7 +1995,7 @@ paths:
get:
summary: List agent tags
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK
@ -2000,7 +2016,7 @@ paths:
post:
summary: Request agent diagnostics
tags:
- Agents
- Elastic Agents
requestBody:
content:
application/json:
@ -2033,7 +2049,7 @@ paths:
post:
summary: Bulk request diagnostics from agents
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK
@ -2080,7 +2096,7 @@ paths:
get:
summary: List agent policies
tags:
- Agent policies
- Elastic Agent policies
responses:
'200':
description: OK
@ -2131,7 +2147,7 @@ paths:
post:
summary: Create agent policy
tags:
- Agent policies
- Elastic Agent policies
responses:
'200':
description: OK
@ -2163,7 +2179,7 @@ paths:
get:
summary: Get agent policy by ID
tags:
- Agent policies
- Elastic Agent policies
responses:
'200':
description: OK
@ -2184,7 +2200,7 @@ paths:
put:
summary: Update agent policy by ID
tags:
- Agent policies
- Elastic Agent policies
responses:
'200':
description: OK
@ -2217,7 +2233,7 @@ paths:
post:
summary: Copy agent policy by ID
tags:
- Agent policies
- Elastic Agent policies
operationId: agent-policy-copy
parameters:
- $ref: '#/components/parameters/kbn_xsrf'
@ -2252,7 +2268,7 @@ paths:
get:
summary: Get full agent policy by ID
tags:
- Agent policies
- Elastic Agent policies
operationId: agent-policy-full
responses:
'200':
@ -2293,7 +2309,7 @@ paths:
get:
summary: Download agent policy by ID
tags:
- Agent policies
- Elastic Agent policies
operationId: agent-policy-download
responses:
'200':
@ -2332,7 +2348,7 @@ paths:
post:
summary: Bulk get agent policies
tags:
- Agent policies
- Elastic Agent policies
requestBody:
content:
application/json:
@ -2374,7 +2390,7 @@ paths:
post:
summary: Delete agent policy by ID
tags:
- Agent policies
- Elastic Agent policies
operationId: delete-agent-policy
responses:
'200':
@ -2436,7 +2452,7 @@ paths:
get:
summary: List enrollment API keys
tags:
- Enrollment API keys
- Fleet enrollment API keys
responses:
'200':
description: OK
@ -2473,7 +2489,7 @@ paths:
post:
summary: Create enrollment API key
tags:
- Enrollment API keys
- Fleet enrollment API keys
responses:
'200':
description: OK
@ -2504,7 +2520,7 @@ paths:
get:
summary: Get enrollment API key by ID
tags:
- Enrollment API keys
- Fleet enrollment API keys
responses:
'200':
description: OK
@ -2524,7 +2540,7 @@ paths:
delete:
summary: Delete enrollment API key by ID
tags:
- Enrollment API keys
- Fleet enrollment API keys
responses:
'200':
description: OK
@ -2549,7 +2565,7 @@ paths:
get:
summary: List enrollment API keys
tags:
- Enrollment API keys
- Fleet enrollment API keys
responses:
'200':
description: OK
@ -2585,7 +2601,7 @@ paths:
post:
summary: Create enrollment API key
tags:
- Enrollment API keys
- Fleet enrollment API keys
responses:
'200':
description: OK
@ -2615,7 +2631,7 @@ paths:
get:
summary: Get enrollment API key by ID
tags:
- Enrollment API keys
- Fleet enrollment API keys
responses:
'200':
description: OK
@ -2634,7 +2650,7 @@ paths:
delete:
summary: Delete enrollment API key by ID
tags:
- Enrollment API keys
- Fleet enrollment API keys
responses:
'200':
description: OK
@ -2658,7 +2674,7 @@ paths:
get:
summary: List package policies
tags:
- Package policies
- Fleet package policies
responses:
'200':
description: OK
@ -2692,7 +2708,7 @@ paths:
post:
summary: Create package policy
tags:
- Package policies
- Fleet package policies
operationId: create-package-policy
responses:
'200':
@ -2725,7 +2741,7 @@ paths:
post:
summary: Bulk get package policies
tags:
- Package policies
- Fleet package policies
requestBody:
content:
application/json:
@ -2765,7 +2781,7 @@ paths:
post:
summary: Delete package policy
tags:
- Package policies
- Fleet package policies
operationId: post-delete-package-policy
requestBody:
content:
@ -2808,7 +2824,7 @@ paths:
post:
summary: Upgrade package policy to a newer package version
tags:
- Package policies
- Fleet package policies
operationId: upgrade-package-policy
requestBody:
content:
@ -2849,7 +2865,7 @@ paths:
post:
summary: Dry run package policy upgrade
tags:
- Package policies
- Fleet package policies
operationId: upgrade-package-policy-dry-run
requestBody:
content:
@ -2895,7 +2911,7 @@ paths:
get:
summary: Get package policy by ID
tags:
- Package policies
- Fleet package policies
responses:
'200':
description: OK
@ -2916,7 +2932,7 @@ paths:
put:
summary: Update package policy by ID
tags:
- Package policies
- Fleet package policies
operationId: update-package-policy
requestBody:
content:
@ -2946,7 +2962,7 @@ paths:
delete:
summary: Delete package policy by ID
tags:
- Package policies
- Fleet package policies
operationId: delete-package-policy
responses:
'200':
@ -2971,7 +2987,7 @@ paths:
get:
summary: List outputs
tags:
- Outputs
- Fleet outputs
responses:
'200':
description: OK
@ -2996,7 +3012,7 @@ paths:
post:
summary: Create output
tags:
- Outputs
- Fleet outputs
responses:
'200':
description: OK
@ -3020,7 +3036,7 @@ paths:
get:
summary: Get output by ID
tags:
- Outputs
- Fleet outputs
responses:
'200':
description: OK
@ -3043,7 +3059,7 @@ paths:
delete:
summary: Delete output by ID
tags:
- Outputs
- Fleet outputs
operationId: delete-output
responses:
'200':
@ -3064,7 +3080,7 @@ paths:
put:
summary: Update output by ID
tags:
- Outputs
- Fleet outputs
operationId: update-output
requestBody:
content:
@ -3089,7 +3105,7 @@ paths:
get:
summary: Get latest output health
tags:
- Outputs
- Fleet outputs
responses:
'200':
description: OK
@ -3120,7 +3136,7 @@ paths:
post:
summary: Generate Logstash API key
tags:
- Outputs
- Fleet outputs
responses:
'200':
description: OK
@ -3140,7 +3156,7 @@ paths:
get:
summary: List agent binary download sources
tags:
- Agent binary download sources
- Elastic Agent binary download sources
responses:
'200':
description: OK
@ -3165,7 +3181,7 @@ paths:
post:
summary: Create agent binary download source
tags:
- Agent binary download sources
- Elastic Agent binary download sources
responses:
'200':
description: OK
@ -3201,7 +3217,7 @@ paths:
get:
summary: Get agent binary download source by ID
tags:
- Agent binary download sources
- Elastic Agent binary download sources
responses:
'200':
description: OK
@ -3226,7 +3242,7 @@ paths:
delete:
summary: Delete agent binary download source by ID
tags:
- Agent binary download sources
- Elastic Agent binary download sources
operationId: delete-download-source
responses:
'200':
@ -3247,7 +3263,7 @@ paths:
put:
summary: Update agent binary download source by ID
tags:
- Agent binary download sources
- Elastic Agent binary download sources
operationId: update-download-source
requestBody:
content:
@ -3444,7 +3460,7 @@ paths:
get:
summary: List proxies
tags:
- Proxies
- Fleet proxies
responses:
'200':
description: OK
@ -3469,7 +3485,7 @@ paths:
post:
summary: Create proxy
tags:
- Proxies
- Fleet proxies
responses:
'200':
description: OK
@ -3510,7 +3526,7 @@ paths:
get:
summary: Get proxy by ID
tags:
- Proxies
- Fleet proxies
responses:
'200':
description: OK
@ -3535,7 +3551,7 @@ paths:
delete:
summary: Delete proxy by ID
tags:
- Proxies
- Fleet proxies
operationId: delete-fleet-proxies
responses:
'200':
@ -3556,7 +3572,7 @@ paths:
put:
summary: Update proxy by ID
tags:
- Proxies
- Fleet proxies
operationId: update-fleet-proxies
requestBody:
content:
@ -3596,7 +3612,7 @@ paths:
get:
summary: Get full K8s agent manifest
tags:
- Kubernetes
- Fleet Kubernetes
responses:
'200':
description: OK
@ -3630,7 +3646,7 @@ paths:
get:
summary: List metadata for latest uninstall tokens per agent policy
tags:
- Uninstall tokens
- Fleet uninstall tokens
responses:
'200':
description: OK
@ -3688,7 +3704,7 @@ paths:
get:
summary: Get one decrypted uninstall token by its ID
tags:
- Uninstall tokens
- Fleet uninstall tokens
responses:
'200':
description: OK
@ -4504,7 +4520,7 @@ components:
type: object
agent_status:
type: string
title: Agent status
title: Elastic Agent status
enum:
- offline
- error

2
x-pack/plugins/fleet/common/openapi/components/schemas/agent_status.yaml
View file

@ -1,5 +1,5 @@
type: string
title: Agent status
title: Elastic Agent status
enum:
- offline
- error

19
x-pack/plugins/fleet/common/openapi/entrypoint.yaml
View file

@ -1,5 +1,21 @@
openapi: 3.0.0
tags: []
tags:
- name: Data streams
- name: Elastic Agents
- name: Elastic Agent actions
- name: Elastic Agent binary download sources
- name: Elastic Agent policies
- name: Elastic Agent status
- name: Elastic Package Manager (EPM)
- name: Fleet enrollment API keys
- name: Fleet internals
- name: Fleet Server hosts
- name: Fleet Kubernetes
- name: Fleet outputs
- name: Fleet package policies
- name: Fleet proxies
- name: Fleet service tokens
- name: Fleet uninstall tokens
info:
title: Fleet
description: OpenAPI schema for Fleet API endpoints
@ -183,7 +199,6 @@ paths:
$ref: paths/uninstall_tokens.yaml
/uninstall_tokens/{uninstallTokenId}:
$ref: paths/uninstall_tokens@{uninstall_token_id}.yaml
components:
securitySchemes:
basicAuth:

4
x-pack/plugins/fleet/common/openapi/paths/agent_download_sources.yaml
View file

@ -1,7 +1,7 @@
get:
summary: List agent binary download sources
tags:
- Agent binary download sources
- Elastic Agent binary download sources
responses:
'200':
description: OK
@ -26,7 +26,7 @@ get:
post:
summary: Create agent binary download source
tags:
- Agent binary download sources
- Elastic Agent binary download sources
responses:
'200':
description: OK

6
x-pack/plugins/fleet/common/openapi/paths/agent_download_sources@{source_id}.yaml
View file

@ -1,7 +1,7 @@
get:
summary: Get agent binary download source by ID
tags:
- Agent binary download sources
- Elastic Agent binary download sources
responses:
'200':
description: OK
@ -26,7 +26,7 @@ parameters:
delete:
summary: Delete agent binary download source by ID
tags:
- Agent binary download sources
- Elastic Agent binary download sources
operationId: delete-download-source
responses:
'200':
@ -47,7 +47,7 @@ delete:
put:
summary: Update agent binary download source by ID
tags:
- Agent binary download sources
- Elastic Agent binary download sources
operationId: update-download-source
requestBody:
content:

4
x-pack/plugins/fleet/common/openapi/paths/agent_policies.yaml
View file

@ -1,7 +1,7 @@
get:
summary: List agent policies
tags:
- Agent policies
- Elastic Agent policies
responses:
'200':
description: OK
@ -47,7 +47,7 @@ get:
post:
summary: Create agent policy
tags:
- Agent policies
- Elastic Agent policies
responses:
'200':
description: OK

2
x-pack/plugins/fleet/common/openapi/paths/agent_policies@_bulk_get.yaml
View file

@ -1,7 +1,7 @@
post:
summary: Bulk get agent policies
tags:
- Agent policies
- Elastic Agent policies
requestBody:
content:
application/json:

2
x-pack/plugins/fleet/common/openapi/paths/agent_policies@delete.yaml
View file

@ -1,7 +1,7 @@
post:
summary: Delete agent policy by ID
tags:
- Agent policies
- Elastic Agent policies
operationId: delete-agent-policy
responses:
'200':

4
x-pack/plugins/fleet/common/openapi/paths/agent_policies@{agent_policy_id}.yaml
View file

@ -7,7 +7,7 @@ parameters:
get:
summary: Get agent policy by ID
tags:
- Agent policies
- Elastic Agent policies
responses:
'200':
description: OK
@ -28,7 +28,7 @@ get:
put:
summary: Update agent policy by ID
tags:
- Agent policies
- Elastic Agent policies
responses:
'200':
description: OK

2
x-pack/plugins/fleet/common/openapi/paths/agent_policies@{agent_policy_id}@copy.yaml
View file

@ -7,7 +7,7 @@ parameters:
post:
summary: Copy agent policy by ID
tags:
- Agent policies
- Elastic Agent policies
operationId: agent-policy-copy
parameters:
- $ref: ../components/headers/kbn_xsrf.yaml

2
x-pack/plugins/fleet/common/openapi/paths/agent_policies@{agent_policy_id}@download.yaml
View file

@ -1,7 +1,7 @@
get:
summary: Download agent policy by ID
tags:
- Agent policies
- Elastic Agent policies
operationId: agent-policy-download
responses:
'200':

2
x-pack/plugins/fleet/common/openapi/paths/agent_policies@{agent_policy_id}@full.yaml
View file

@ -1,7 +1,7 @@
get:
summary: Get full agent policy by ID
tags:
- Agent policies
- Elastic Agent policies
operationId: agent-policy-full
responses:
'200':

2
x-pack/plugins/fleet/common/openapi/paths/agent_status.yaml
View file

@ -1,7 +1,7 @@
get:
summary: Get agent status summary
tags:
- Agent status
- Elastic Agent status
responses:
'200':
description: OK

2
x-pack/plugins/fleet/common/openapi/paths/agent_status@data.yaml
View file

@ -1,7 +1,7 @@
get:
summary: Get incoming agent data
tags:
- Agent status
- Elastic Agent status
responses:
'200':
description: OK

2
x-pack/plugins/fleet/common/openapi/paths/agent_status_deprecated.yaml
View file

@ -1,7 +1,7 @@
get:
summary: Get agent status summary
tags:
- Agent status
- Elastic Agent status
responses:
'200':
description: OK

2
x-pack/plugins/fleet/common/openapi/paths/agent_tags.yaml
View file

@ -1,7 +1,7 @@
get:
summary: List agent tags
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK

4
x-pack/plugins/fleet/common/openapi/paths/agents.yaml
View file

@ -1,7 +1,7 @@
get:
summary: List agents
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK
@ -31,7 +31,7 @@ get:
post:
summary: List agents by action ids
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK

2
x-pack/plugins/fleet/common/openapi/paths/agents@action_status.yaml
View file

@ -1,7 +1,7 @@
get:
summary: Get agent action status
tags:
- Agent actions
- Elastic Agent actions
parameters:
- $ref: ../components/parameters/page_size.yaml
- $ref: ../components/parameters/page_index.yaml

2
x-pack/plugins/fleet/common/openapi/paths/agents@bulk_reassign.yaml
View file

@ -1,7 +1,7 @@
post:
summary: Bulk reassign agents
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK

2
x-pack/plugins/fleet/common/openapi/paths/agents@bulk_request_diagnostics.yaml
View file

@ -1,7 +1,7 @@
post:
summary: Bulk request diagnostics from agents
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK

2
x-pack/plugins/fleet/common/openapi/paths/agents@bulk_unenroll.yaml
View file

@ -1,7 +1,7 @@
post:
summary: Bulk unenroll agents
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK

2
x-pack/plugins/fleet/common/openapi/paths/agents@bulk_update_tags.yaml
View file

@ -1,7 +1,7 @@
post:
summary: Bulk update agent tags
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK

2
x-pack/plugins/fleet/common/openapi/paths/agents@bulk_upgrade.yaml
View file

@ -1,7 +1,7 @@
post:
summary: Bulk upgrade agents
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK

2
x-pack/plugins/fleet/common/openapi/paths/agents@current_upgrades.yaml
View file

@ -1,7 +1,7 @@
get:
summary: List current bulk upgrade operations
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK

2
x-pack/plugins/fleet/common/openapi/paths/agents@files@{file_id}.yaml
View file

@ -7,7 +7,7 @@ parameters:
delete:
summary: Delete file uploaded by agent
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK

2
x-pack/plugins/fleet/common/openapi/paths/agents@files@{file_id}@{file_name}.yaml
View file

@ -12,7 +12,7 @@ parameters:
get:
summary: Get file uploaded by agent
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK

4
x-pack/plugins/fleet/common/openapi/paths/agents@setup.yaml
View file

@ -1,7 +1,7 @@
get:
summary: Get agent setup info
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK
@ -17,7 +17,7 @@ get:
post:
summary: Initiate agent setup
tags:
- Agents
- Elastic Agents
operationId: setup-agents
responses:
'200':

6
x-pack/plugins/fleet/common/openapi/paths/agents@{agent_id}.yaml
View file

@ -7,7 +7,7 @@ parameters:
get:
summary: Get agent by ID
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK
@ -28,7 +28,7 @@ get:
put:
summary: Update agent by ID
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK
@ -62,7 +62,7 @@ put:
delete:
summary: Delete agent by ID
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK

2
x-pack/plugins/fleet/common/openapi/paths/agents@{agent_id}@actions.yaml
View file

@ -7,7 +7,7 @@ parameters:
post:
summary: Create agent action
tags:
- Agent actions
- Elastic Agent actions
responses:
'200':
description: OK

2
x-pack/plugins/fleet/common/openapi/paths/agents@{agent_id}@actions@{action_id}@cancel.yaml
View file

@ -12,7 +12,7 @@ parameters:
post:
summary: Cancel agent action
tags:
- Agent actions
- Elastic Agent actions
responses:
'200':
description: OK

4
x-pack/plugins/fleet/common/openapi/paths/agents@{agent_id}@reassign.yaml
View file

@ -7,7 +7,7 @@ parameters:
post:
summary: Reassign agent
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK
@ -34,7 +34,7 @@ post:
put:
summary: Reassign agent
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK

2
x-pack/plugins/fleet/common/openapi/paths/agents@{agent_id}@request_diagnostics.yaml
View file

@ -7,7 +7,7 @@ parameters:
post:
summary: Request agent diagnostics
tags:
- Agents
- Elastic Agents
requestBody:
content:
application/json:

2
x-pack/plugins/fleet/common/openapi/paths/agents@{agent_id}@unenroll.yaml
View file

@ -7,7 +7,7 @@ parameters:
post:
summary: Unenroll agent
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK

2
x-pack/plugins/fleet/common/openapi/paths/agents@{agent_id}@upgrade.yaml
View file

@ -7,7 +7,7 @@ parameters:
post:
summary: Upgrade agent
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK

2
x-pack/plugins/fleet/common/openapi/paths/agents@{agent_id}@uploads.yaml
View file

@ -7,7 +7,7 @@ parameters:
get:
summary: List agent uploads
tags:
- Agents
- Elastic Agents
responses:
'200':
description: OK

4
x-pack/plugins/fleet/common/openapi/paths/enrollment_api_keys.yaml
View file

@ -1,7 +1,7 @@
get:
summary: List enrollment API keys
tags:
- Enrollment API keys
- Fleet enrollment API keys
responses:
'200':
description: OK
@ -37,7 +37,7 @@ get:
post:
summary: Create enrollment API key
tags:
- Enrollment API keys
- Fleet enrollment API keys
responses:
'200':
description: OK

4
x-pack/plugins/fleet/common/openapi/paths/enrollment_api_keys@{key_id}.yaml
View file

@ -7,7 +7,7 @@ parameters:
get:
summary: Get enrollment API key by ID
tags:
- Enrollment API keys
- Fleet enrollment API keys
responses:
'200':
description: OK
@ -26,7 +26,7 @@ get:
delete:
summary: Delete enrollment API key by ID
tags:
- Enrollment API keys
- Fleet enrollment API keys
responses:
'200':
description: OK

4
x-pack/plugins/fleet/common/openapi/paths/enrollment_api_keys@{key_id}_deprecated.yaml
View file

@ -7,7 +7,7 @@ parameters:
get:
summary: Get enrollment API key by ID
tags:
- Enrollment API keys
- Fleet enrollment API keys
responses:
'200':
description: OK
@ -27,7 +27,7 @@ get:
delete:
summary: Delete enrollment API key by ID
tags:
- Enrollment API keys
- Fleet enrollment API keys
responses:
'200':
description: OK

4
x-pack/plugins/fleet/common/openapi/paths/enrollment_api_keys_deprecated.yaml
View file

@ -1,7 +1,7 @@
get:
summary: List enrollment API keys
tags:
- Enrollment API keys
- Fleet enrollment API keys
responses:
'200':
description: OK
@ -38,7 +38,7 @@ get:
post:
summary: Create enrollment API key
tags:
- Enrollment API keys
- Fleet enrollment API keys
responses:
'200':
description: OK

2
x-pack/plugins/fleet/common/openapi/paths/kubernetes.yaml
View file

@ -1,7 +1,7 @@
get:
summary: Get full K8s agent manifest
tags:
- Kubernetes
- Fleet Kubernetes
responses:
'200':
description: OK

2
x-pack/plugins/fleet/common/openapi/paths/logstash_api_keys.yaml
View file

@ -1,7 +1,7 @@
post:
summary: Generate Logstash API key
tags:
- Outputs
- Fleet outputs
responses:
'200':
description: OK

2
x-pack/plugins/fleet/common/openapi/paths/output_health@{output_id}.yaml
View file

@ -1,7 +1,7 @@
get:
summary: Get latest output health
tags:
- Outputs
- Fleet outputs
responses:
'200':
description: OK

4
x-pack/plugins/fleet/common/openapi/paths/outputs.yaml
View file

@ -1,7 +1,7 @@
get:
summary: List outputs
tags:
- Outputs
- Fleet outputs
responses:
'200':
description: OK
@ -26,7 +26,7 @@ get:
post:
summary: Create output
tags:
- Outputs
- Fleet outputs
responses:
'200':
description: OK

6
x-pack/plugins/fleet/common/openapi/paths/outputs@{output_id}.yaml
View file

@ -1,7 +1,7 @@
get:
summary: Get output by ID
tags:
- Outputs
- Fleet outputs
responses:
'200':
description: OK
@ -24,7 +24,7 @@ parameters:
delete:
summary: Delete output by ID
tags:
- Outputs
- Fleet outputs
operationId: delete-output
responses:
'200':
@ -45,7 +45,7 @@ delete:
put:
summary: Update output by ID
tags:
- Outputs
- Fleet outputs
operationId: update-output
requestBody:
content:

4
x-pack/plugins/fleet/common/openapi/paths/package_policies.yaml
View file

@ -1,7 +1,7 @@
get:
summary: List package policies
tags:
- Package policies
- Fleet package policies
responses:
'200':
description: OK
@ -35,7 +35,7 @@ parameters: []
post:
summary: Create package policy
tags:
- Package policies
- Fleet package policies
operationId: create-package-policy
responses:
'200':

2
x-pack/plugins/fleet/common/openapi/paths/package_policies@_bulk_get.yaml
View file

@ -1,7 +1,7 @@
post:
summary: Bulk get package policies
tags:
- Package policies
- Fleet package policies
requestBody:
content:
application/json:

2
x-pack/plugins/fleet/common/openapi/paths/package_policies@delete.yaml
View file

@ -1,7 +1,7 @@
post:
summary: Delete package policy
tags:
- Package policies
- Fleet package policies
operationId: post-delete-package-policy
requestBody:
content:

2
x-pack/plugins/fleet/common/openapi/paths/package_policies@upgrade.yaml
View file

@ -1,7 +1,7 @@
post:
summary: Upgrade package policy to a newer package version
tags:
- Package policies
- Fleet package policies
operationId: upgrade-package-policy
requestBody:
content:

2
x-pack/plugins/fleet/common/openapi/paths/package_policies@upgrade_dryrun.yaml
View file

@ -1,7 +1,7 @@
post:
summary: Dry run package policy upgrade
tags:
- Package policies
- Fleet package policies
operationId: upgrade-package-policy-dry-run
requestBody:
content:

6
x-pack/plugins/fleet/common/openapi/paths/package_policies@{package_policy_id}.yaml
View file

@ -7,7 +7,7 @@ parameters:
get:
summary: Get package policy by ID
tags:
- Package policies
- Fleet package policies
responses:
'200':
description: OK
@ -28,7 +28,7 @@ get:
put:
summary: Update package policy by ID
tags:
- Package policies
- Fleet package policies
operationId: update-package-policy
requestBody:
content:
@ -58,7 +58,7 @@ put:
delete:
summary: Delete package policy by ID
tags:
- Package policies
- Fleet package policies
operationId: delete-package-policy
responses:
'200':

4
x-pack/plugins/fleet/common/openapi/paths/proxies.yaml
View file

@ -1,7 +1,7 @@
get:
summary: List proxies
tags:
- Proxies
- Fleet proxies
responses:
'200':
description: OK
@ -26,7 +26,7 @@ get:
post:
summary: Create proxy
tags:
- Proxies
- Fleet proxies
responses:
'200':
description: OK

6
x-pack/plugins/fleet/common/openapi/paths/proxies@{item_id}.yaml
View file

@ -1,7 +1,7 @@
get:
summary: Get proxy by ID
tags:
- Proxies
- Fleet proxies
responses:
'200':
description: OK
@ -26,7 +26,7 @@ parameters:
delete:
summary: Delete proxy by ID
tags:
- Proxies
- Fleet proxies
operationId: delete-fleet-proxies
responses:
'200':
@ -47,7 +47,7 @@ delete:
put:
summary: Update proxy by ID
tags:
- Proxies
- Fleet proxies
operationId: update-fleet-proxies
requestBody:
content:

2
x-pack/plugins/fleet/common/openapi/paths/service_tokens.yaml
View file

@ -1,7 +1,7 @@
post:
summary: Create service token
tags:
- Service tokens
- Fleet service tokens
responses:
'200':
description: OK

2
x-pack/plugins/fleet/common/openapi/paths/service_tokens_deprecated.yaml
View file

@ -1,7 +1,7 @@
post:
summary: Create service token
tags:
- Service tokens
- Fleet service tokens
responses:
'200':
description: OK

2
x-pack/plugins/fleet/common/openapi/paths/uninstall_tokens.yaml
View file

@ -1,7 +1,7 @@
get:
summary: List metadata for latest uninstall tokens per agent policy
tags:
- Uninstall tokens
- Fleet uninstall tokens
responses:
'200':
description: OK

2
x-pack/plugins/fleet/common/openapi/paths/uninstall_tokens@{uninstall_token_id}.yaml
View file

@ -1,7 +1,7 @@
get:
summary: Get one decrypted uninstall token by its ID
tags:
- Uninstall tokens
- Fleet uninstall tokens
responses:
'200':
description: OK