Interact with the Kibana APIs through the
curl command and HTTP and HTTPs protocols.
It is recommended that you use HTTPs on port 5601 because it is more secure.
The Kibana Console supports only Elasticsearch APIs. You are unable to interact with the Kibana APIs with the Console and must use
curl or another HTTP tool instead. For more information, refer to Console.
Kibana supports token-based authentication with the same username and password that you use to log into the Kibana Console.
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.
Calls to the API endpoints require different operations. To interact with the Kibana APIs, use the following operations:
- GET - Fetches the information.
- POST - Adds new information.
- PUT - Updates the existing information.
- DELETE - Removes the information.
For example, the following
curl command exports a dashboard:
curl -X POST -u $USER:$PASSWORD "localhost:5601/api/kibana/dashboards/export?dashboard=942dcef0-b2cd-11e8-ad8e-85441f0c2e5c"
The following Kibana APIs are available: