Elastic Stack (ELK Stack) Fleet proxies API
Fleet proxies APIs enable you to manage Fleet proxies, including creating, updating, and deleting proxy configurations for Fleet agent communication.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/elk-stack-fleet-proxies-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
contact:
name: Kibana Team
description: The Kibana REST APIs enable you to manage resources such as connectors, data views, and saved objects.
title: Kibana 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:**
get /s/{space_id}/api/fleet/proxies
Refer to Spaces for more information.
List all Fleet proxies.
[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:
type:
- string
- 'null'
certificate_authorities:
type:
- string
- 'null'
certificate_key:
type:
- string
- 'null'
id:
type: string
is_preconfigured:
default: false
type: boolean
name:
type: string
proxy_headers:
additionalProperties:
anyOf:
- type: string
- type: boolean
- type: number
type:
- object
- 'null'
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: {}
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:**
post /s/{space_id}/api/fleet/proxies
Refer to Spaces for more information.
Create a new Fleet proxy.
[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:
type:
- string
- 'null'
certificate_authorities:
type:
- string
- 'null'
certificate_key:
type:
- string
- 'null'
id:
type: string
is_preconfigured:
default: false
type: boolean
name:
type: string
proxy_headers:
additionalProperties:
anyOf:
- type: string
- type: boolean
- type: number
type:
- object
- 'null'
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:
type:
- string
- 'null'
certificate_authorities:
type:
- string
- 'null'
certificate_key:
type:
- string
- 'null'
id:
type: string
is_preconfigured:
default: false
type: boolean
name:
type: string
proxy_headers:
additionalProperties:
anyOf:
- type: string
- type: boolean
- type: number
type:
- object
- 'null'
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: {}
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:**
delete /s/{space_id}/api/fleet/proxies/{itemId}
Refer to Spaces for more information.
Delete a proxy by ID
[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: {}
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:**
get /s/{space_id}/api/fleet/proxies/{itemId}
Refer to Spaces for more information.
Get a proxy by ID.
[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:
type:
- string
- 'null'
certificate_authorities:
type:
- string
- 'null'
certificate_key:
type:
- string
- 'null'
id:
type: string
is_preconfigured:
default: false
type: boolean
name:
type: string
proxy_headers:
additionalProperties:
anyOf:
- type: string
- type: boolean
- type: number
type:
- object
- 'null'
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: {}
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:**
put /s/{space_id}/api/fleet/proxies/{itemId}
Refer to Spaces for more information.
Update a proxy by ID.
[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:
default: null
type:
- string
- 'null'
certificate_authorities:
default: null
type:
- string
- 'null'
certificate_key:
default: null
type:
- string
- 'null'
name:
type: string
proxy_headers:
additionalProperties:
anyOf:
- type: string
- type: boolean
- type: number
type:
- object
- 'null'
url:
type: string
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:
type:
- string
- 'null'
certificate_authorities:
type:
- string
- 'null'
certificate_key:
type:
- string
- 'null'
id:
type: string
is_preconfigured:
default: false
type: boolean
name:
type: string
proxy_headers:
additionalProperties:
anyOf:
- type: string
- type: boolean
- type: number
type:
- object
- 'null'
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: {}
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"