Kibana Fleet proxies API
Fleet proxies APIs enable you to manage Fleet proxies, including creating, updating, and deleting proxy configurations for Fleet agent communication.
OpenAPI Specification
openapi: 3.0.3
info:
contact:
name: Kibana Team
description: 'The Kibana REST APIs enable you to manage resources such as connectors, data views, and saved objects.
The API calls are stateless.
Each request that you make happens in isolation from other calls and must include all of the necessary information for Kibana to fulfill the
request.
API requests return JSON output, which is a format that is machine-readable and works well for automation.
To interact with Kibana APIs, use the following operations:
- GET: Fetches the information.
- PATCH: Applies partial modifications to the existing information.
- POST: Adds new information.
- PUT: Updates the existing information.
- DELETE: Removes the information.
You can prepend any Kibana API endpoint with `kbn:` and run the request in **Dev Tools → Console**.
For example:
```
GET kbn:/api/data_views
```
For more information about the console, refer to [Run API requests](https://www.elastic.co/docs/explore-analyze/query-filter/tools/console).
NOTE: Access to internal Kibana API endpoints will be restricted in Kibana version 9.0. Please move any integrations to publicly documented APIs.
## Documentation source and versions
This documentation is derived from the `main` branch of the [kibana](https://github.com/elastic/kibana) repository.
It is provided under license [Attribution-NonCommercial-NoDerivatives 4.0 International](https://creativecommons.org/licenses/by-nc-nd/4.0/).
This documentation contains work-in-progress information for future Elastic Stack releases.
'
title: Kibana APIs Actions Fleet proxies API
version: ''
x-doc-license:
name: Attribution-NonCommercial-NoDerivatives 4.0 International
url: https://creativecommons.org/licenses/by-nc-nd/4.0/
x-feedbackLink:
label: Feedback
url: https://github.com/elastic/docs-content/issues/new?assignees=&labels=feedback%2Ccommunity&projects=&template=api-feedback.yaml&title=%5BFeedback%5D%3A+
servers:
- url: https://{kibana_url}
variables:
kibana_url:
default: localhost:5601
security:
- apiKeyAuth: []
- basicAuth: []
tags:
- name: Fleet proxies
description: 'Fleet proxies APIs enable you to manage Fleet proxies, including creating, updating, and deleting proxy configurations for Fleet agent communication.
'
x-displayName: Fleet proxies
paths:
/api/fleet/proxies:
get:
description: '**Spaces method and path for this operation:**
<div><span class="operation-verb get">get</span> <span class="operation-path">/s/{space_id}/api/fleet/proxies</span></div>
Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.
List all Fleet proxies.<br/><br/>[Required authorization] Route required privileges: fleet-settings-read.'
operationId: get-fleet-proxies
parameters: []
responses:
'200':
content:
application/json:
examples:
getFleetProxiesExample:
description: List of Fleet proxies
value:
items:
- id: proxy-id-1
is_preconfigured: false
name: My proxy
url: http://proxy.example.com:3128
page: 1
perPage: 20
total: 1
schema:
additionalProperties: false
type: object
properties:
items:
items:
additionalProperties: false
type: object
properties:
certificate:
nullable: true
type: string
certificate_authorities:
nullable: true
type: string
certificate_key:
nullable: true
type: string
id:
type: string
is_preconfigured:
default: false
type: boolean
name:
type: string
proxy_headers:
additionalProperties:
anyOf:
- type: string
- type: boolean
- type: number
nullable: true
type: object
url:
type: string
required:
- id
- url
- name
maxItems: 10000
type: array
page:
type: number
perPage:
type: number
total:
type: number
required:
- items
- total
- page
- perPage
description: Successful response
'400':
content:
application/json:
examples:
genericErrorResponseExample:
description: Example of a generic error response
value:
error: Bad Request
message: An error message describing what went wrong
statusCode: 400
schema:
additionalProperties: false
description: Generic Error
type: object
properties:
attributes:
nullable: true
error:
type: string
errorType:
type: string
message:
type: string
statusCode:
type: number
required:
- message
- attributes
description: Bad Request
summary: Get proxies
tags:
- Fleet proxies
x-metaTags:
- content: Kibana
name: product_name
post:
description: '**Spaces method and path for this operation:**
<div><span class="operation-verb post">post</span> <span class="operation-path">/s/{space_id}/api/fleet/proxies</span></div>
Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.
Create a new Fleet proxy.<br/><br/>[Required authorization] Route required privileges: fleet-settings-all.'
operationId: post-fleet-proxies
parameters:
- description: A required header to protect against CSRF attacks
in: header
name: kbn-xsrf
required: true
schema:
example: 'true'
type: string
requestBody:
content:
application/json:
examples:
postFleetProxyRequestExample:
description: Create a new Fleet proxy
value:
name: My proxy
url: http://proxy.example.com:3128
schema:
additionalProperties: false
type: object
properties:
certificate:
nullable: true
type: string
certificate_authorities:
nullable: true
type: string
certificate_key:
nullable: true
type: string
id:
type: string
is_preconfigured:
default: false
type: boolean
name:
type: string
proxy_headers:
additionalProperties:
anyOf:
- type: string
- type: boolean
- type: number
nullable: true
type: object
url:
type: string
required:
- url
- name
responses:
'200':
content:
application/json:
examples:
postFleetProxyExample:
description: The created Fleet proxy
value:
item:
id: proxy-id-2
is_preconfigured: false
name: My proxy
url: http://proxy.example.com:3128
schema:
additionalProperties: false
type: object
properties:
item:
additionalProperties: false
type: object
properties:
certificate:
nullable: true
type: string
certificate_authorities:
nullable: true
type: string
certificate_key:
nullable: true
type: string
id:
type: string
is_preconfigured:
default: false
type: boolean
name:
type: string
proxy_headers:
additionalProperties:
anyOf:
- type: string
- type: boolean
- type: number
nullable: true
type: object
url:
type: string
required:
- id
- url
- name
required:
- item
description: Successful response
'400':
content:
application/json:
examples:
genericErrorResponseExample:
description: Example of a generic error response
value:
error: Bad Request
message: An error message describing what went wrong
statusCode: 400
schema:
additionalProperties: false
description: Generic Error
type: object
properties:
attributes:
nullable: true
error:
type: string
errorType:
type: string
message:
type: string
statusCode:
type: number
required:
- message
- attributes
description: Bad Request
summary: Create a proxy
tags:
- Fleet proxies
x-metaTags:
- content: Kibana
name: product_name
/api/fleet/proxies/{itemId}:
delete:
description: '**Spaces method and path for this operation:**
<div><span class="operation-verb delete">delete</span> <span class="operation-path">/s/{space_id}/api/fleet/proxies/{itemId}</span></div>
Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.
Delete a proxy by ID<br/><br/>[Required authorization] Route required privileges: fleet-settings-all.'
operationId: delete-fleet-proxies-itemid
parameters:
- description: A required header to protect against CSRF attacks
in: header
name: kbn-xsrf
required: true
schema:
example: 'true'
type: string
- description: The ID of the proxy
in: path
name: itemId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
examples:
deleteFleetProxyExample:
description: The Fleet proxy was successfully deleted
value:
id: proxy-id-1
schema:
additionalProperties: false
type: object
properties:
id:
type: string
required:
- id
description: Successful response
'400':
content:
application/json:
examples:
genericErrorResponseExample:
description: Example of a generic error response
value:
error: Bad Request
message: An error message describing what went wrong
statusCode: 400
schema:
additionalProperties: false
description: Generic Error
type: object
properties:
attributes:
nullable: true
error:
type: string
errorType:
type: string
message:
type: string
statusCode:
type: number
required:
- message
- attributes
description: Bad Request
'404':
content:
application/json:
examples:
notFoundExample:
description: No proxy was found with the given ID
value:
error: Not Found
message: Fleet proxy proxy-id-1 not found
statusCode: 404
description: Not Found
summary: Delete a proxy
tags:
- Fleet proxies
x-metaTags:
- content: Kibana
name: product_name
get:
description: '**Spaces method and path for this operation:**
<div><span class="operation-verb get">get</span> <span class="operation-path">/s/{space_id}/api/fleet/proxies/{itemId}</span></div>
Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.
Get a proxy by ID.<br/><br/>[Required authorization] Route required privileges: fleet-settings-read.'
operationId: get-fleet-proxies-itemid
parameters:
- description: The ID of the proxy
in: path
name: itemId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
examples:
getFleetProxyExample:
description: A Fleet proxy
value:
item:
id: proxy-id-1
is_preconfigured: false
name: My proxy
url: http://proxy.example.com:3128
schema:
additionalProperties: false
type: object
properties:
item:
additionalProperties: false
type: object
properties:
certificate:
nullable: true
type: string
certificate_authorities:
nullable: true
type: string
certificate_key:
nullable: true
type: string
id:
type: string
is_preconfigured:
default: false
type: boolean
name:
type: string
proxy_headers:
additionalProperties:
anyOf:
- type: string
- type: boolean
- type: number
nullable: true
type: object
url:
type: string
required:
- id
- url
- name
required:
- item
description: Successful response
'400':
content:
application/json:
examples:
genericErrorResponseExample:
description: Example of a generic error response
value:
error: Bad Request
message: An error message describing what went wrong
statusCode: 400
schema:
additionalProperties: false
description: Generic Error
type: object
properties:
attributes:
nullable: true
error:
type: string
errorType:
type: string
message:
type: string
statusCode:
type: number
required:
- message
- attributes
description: Bad Request
'404':
content:
application/json:
examples:
notFoundExample:
description: No proxy was found with the given ID
value:
error: Not Found
message: Fleet proxy proxy-id-1 not found
statusCode: 404
description: Not Found
summary: Get a proxy
tags:
- Fleet proxies
x-metaTags:
- content: Kibana
name: product_name
put:
description: '**Spaces method and path for this operation:**
<div><span class="operation-verb put">put</span> <span class="operation-path">/s/{space_id}/api/fleet/proxies/{itemId}</span></div>
Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.
Update a proxy by ID.<br/><br/>[Required authorization] Route required privileges: fleet-settings-all.'
operationId: put-fleet-proxies-itemid
parameters:
- description: A required header to protect against CSRF attacks
in: header
name: kbn-xsrf
required: true
schema:
example: 'true'
type: string
- description: The ID of the proxy
in: path
name: itemId
required: true
schema:
type: string
requestBody:
content:
application/json:
examples:
putFleetProxyRequestExample:
description: Update a Fleet proxy
value:
name: Updated proxy
url: http://updated-proxy.example.com:3128
schema:
additionalProperties: false
type: object
properties:
certificate:
nullable: true
type: string
certificate_authorities:
nullable: true
type: string
certificate_key:
nullable: true
type: string
name:
type: string
proxy_headers:
additionalProperties:
anyOf:
- type: string
- type: boolean
- type: number
nullable: true
type: object
url:
type: string
required:
- certificate_authorities
- certificate
- certificate_key
responses:
'200':
content:
application/json:
examples:
putFleetProxyExample:
description: The updated Fleet proxy
value:
item:
id: proxy-id-1
is_preconfigured: false
name: Updated proxy
url: http://updated-proxy.example.com:3128
schema:
additionalProperties: false
type: object
properties:
item:
additionalProperties: false
type: object
properties:
certificate:
nullable: true
type: string
certificate_authorities:
nullable: true
type: string
certificate_key:
nullable: true
type: string
id:
type: string
is_preconfigured:
default: false
type: boolean
name:
type: string
proxy_headers:
additionalProperties:
anyOf:
- type: string
- type: boolean
- type: number
nullable: true
type: object
url:
type: string
required:
- id
- url
- name
required:
- item
description: Successful response
'400':
content:
application/json:
examples:
genericErrorResponseExample:
description: Example of a generic error response
value:
error: Bad Request
message: An error message describing what went wrong
statusCode: 400
schema:
additionalProperties: false
description: Generic Error
type: object
properties:
attributes:
nullable: true
error:
type: string
errorType:
type: string
message:
type: string
statusCode:
type: number
required:
- message
- attributes
description: Bad Request
'404':
content:
application/json:
examples:
notFoundExample:
description: No proxy was found with the given ID
value:
error: Not Found
message: Proxy proxy-id-1 not found
statusCode: 404
description: Not Found
summary: Update a proxy
tags:
- Fleet proxies
x-metaTags:
- content: Kibana
name: product_name
components:
securitySchemes:
apiKeyAuth:
description: 'These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: `Authorization: ApiKey base64AccessApiKey`
'
in: header
name: Authorization
type: apiKey
basicAuth:
scheme: basic
type: http
x-topics:
- title: Kibana spaces
content: "Spaces enable you to organize your dashboards and other saved objects into meaningful categories.\nYou can use the default space or create your own spaces.\n\nTo run APIs in non-default spaces, you must add `s/{space_id}/` to the path.\nFor example:\n\n```bash\ncurl -X GET \"http://${KIBANA_URL}/s/marketing/api/data_views\" \\\n -H \"Authorization: ApiKey ${API_KEY}\"\n```\n\nIf you use the Kibana console to send API requests, it automatically adds the appropriate space identifier.\n\nTo learn more, check out [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces).\n"