Work with Elastic APIs

edit

Most Elastic resources can be accessed and managed through RESTful APIs. While the Elasticsearch Service API is used to manage your deployments and their components, the Elasticsearch and Kibana APIs provide direct access to your data and your visualizations, respectively.

Elasticsearch Service API

You can use the Elasticsearch Service API to manage your deployments and all of the resources associated with them. This includes performing deployment CRUD operations, scaling or autoscaling resources, and managing traffic filters, deployment extensions, remote clusters, and Elastic Stack versions. You can also access cost data by deployment and by organization.

To learn more about the Elasticsearch Service API, read through the API overview, try out some getting started examples, and check our API reference documentation.

Calls to the Elasticsearch Service API are subject to Rate limiting.

Elasticsearch APIs

This set of APIs allows you to interact directly with the Elasticsearch nodes in your deployment. You can ingest data, run search queries, check the health of your clusters, manage snapshots, and more.

To use these APIs in Elasticsearch Service read our topic Access the Elasticsearch API console, and to learn about all of the available endpoints check the Elasticsearch API reference documentation.

Some restrictions apply when using the Elasticsearch APIs in Elasticsearch Service.

Kibana APIs

Many Kibana features can be accessed through these APIs, including Kibana objects, patterns, and dashboards, as well as user roles and user sessions. You can use these APIs to configure alerts and actions, and to access health details for the Kibana Task Manager.

The Kibana APIs cannot be accessed directly from the Elasticsearch Service console; you need to use curl or another HTTP tool to connect. Check the Kibana API reference documentation to learn about using the APIs and for details about all available endpoints.

Some restrictions apply when using these APIs with an Elasticsearch Service Kibana instance as compared to an on-prem installation.

Other Products

Most other Elastic products have APIs to support machine-to-machine operations. You can find the documentation for these at the following links: