mirror of
https://github.com/elastic/kibana.git
synced 2025-04-22 17:04:01 -04:00
60 lines
2.4 KiB
YAML
60 lines
2.4 KiB
YAML
openapi: 3.0.3
|
|
info:
|
|
title: Kibana APIs
|
|
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/guide/en/kibana/current/console-kibana.html).
|
|
|
|
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.
|
|
version: '1.0.2'
|
|
x-doc-license:
|
|
name: Attribution-NonCommercial-NoDerivatives 4.0 International
|
|
url: https://creativecommons.org/licenses/by-nc-nd/4.0/
|
|
contact:
|
|
name: Kibana Team
|
|
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+
|
|
security:
|
|
- apiKeyAuth: []
|
|
- basicAuth: []
|
|
components:
|
|
securitySchemes:
|
|
apiKeyAuth:
|
|
type: apiKey
|
|
in: header
|
|
name: Authorization
|
|
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`
|
|
basicAuth:
|
|
type: http
|
|
scheme: basic
|