Kibana Fleet API
The Fleet API from Kibana — 1 operation(s) for fleet.
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 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
paths:
/api/fleet/space_settings:
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/space_settings</span></div>
Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.
Get the Fleet settings for the current Kibana space.'
operationId: get-fleet-space-settings
parameters: []
responses:
'200':
content:
application/json:
examples:
getSpaceSettingsExample:
description: The Fleet settings for the current Kibana space
value:
item:
allowed_namespace_prefixes:
- team-a
- team-b
schema:
additionalProperties: false
type: object
properties:
item:
additionalProperties: false
type: object
properties:
allowed_namespace_prefixes:
items:
type: string
maxItems: 100
type: array
managed_by:
type: string
required:
- allowed_namespace_prefixes
required:
- item
description: Successful response
summary: Get space settings
tags:
- Fleet
x-state: Generally available; added in 9.1.0
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/space_settings</span></div>
Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.
Create or update Fleet settings for the current Kibana space.<br/><br/>[Required authorization] Route required privileges: fleet-settings-all.'
operationId: put-fleet-space-settings
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:
putSpaceSettingsRequestExample:
description: Update allowed namespace prefixes for the current Kibana space
value:
allowed_namespace_prefixes:
- team-a
- team-b
schema:
additionalProperties: false
type: object
properties:
allowed_namespace_prefixes:
items:
type: string
maxItems: 10
type: array
responses:
'200':
content:
application/json:
examples:
putSpaceSettingsExample:
description: The updated Fleet settings for the current Kibana space
value:
item:
allowed_namespace_prefixes:
- team-a
- team-b
schema:
additionalProperties: false
type: object
properties:
item:
additionalProperties: false
type: object
properties:
allowed_namespace_prefixes:
items:
type: string
maxItems: 100
type: array
managed_by:
type: string
required:
- allowed_namespace_prefixes
required:
- item
description: Successful response
summary: Create space settings
tags:
- Fleet
x-state: Generally available; added in 9.1.0
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"