Tools and APIs for Elastic Cloud
Elastic Cloud Hosted Serverless
Review key resources that can be used to interact with and manage your Elastic Cloud organization, Elastic Cloud Hosted deployments, and Elastic Cloud Serverless projects.
You can use the following APIs in an Elastic Cloud environment.
Refer to API keys to learn how to generate API keys for your environment.
The following REST APIs allow you to manage your Elastic Cloud organization, users, security, billing and resources.
| Area | API | Tasks |
|---|---|---|
| Elastic Cloud organization Elastic Cloud Hosted deployments |
Elastic Cloud API | Manage your Cloud organization, members, costs, billing, and more. Manage your hosted deployments and all of the resources associated with them, including scaling or autoscaling resources, and managing traffic filters, deployment extensions, remote clusters, and Elastic Stack versions. Refer to Elastic Cloud RESTful API for usage information and examples. |
| Elastic Cloud Serverless projects | Elastic Cloud Serverless API | Manage Elastic Cloud Serverless projects. |
| Elastic Cloud services | Service Status API | Programmatically ingest service status updates. |
The following APIs allow you to interact with your Elasticsearch cluster, its data, and the features available to you in your Elastic Cloud Hosted deployments and Elastic Cloud Serverless projects. Separate APIs are used for Elastic Cloud Hosted and Elastic Cloud Serverless.
Note that some restrictions apply when using the these APIs on Elastic Cloud.
Refer to Elasticsearch API conventions to learn about headers, request body conventions, and examples for Elasticsearch Serverless and Elasticsearch REST APIs.
The following APIs are available for Elasticsearch Serverless users:
Elasticsearch Serverless APIs: Use these APIs to index, manage, search, and analyze your data in Elasticsearch Serverless.
Learn how to connect to your Elasticsearch Serverless endpoint.
Kibana Serverless APIs: Use these APIs to manage resources such as connectors, data views, and saved objects for your Elastic Cloud Serverless project.
The following APIs are available for Elastic Cloud Hosted users:
- 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.
- 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.
Some other Elastic products have APIs to support machine-to-machine operations:
Elastic Cloud Hosted Serverless Unavailable
With the Elasticsearch API console, you can interact with a specific Elasticsearch deployment directly from the Elastic Cloud Console or Cloud UI without having to authenticate again. This RESTful API access is limited to the specific cluster and works only for Elasticsearch API calls.
You can find this console in the Elastic Cloud Console or Cloud UI when selecting a specific deployment to manage. From the Elasticsearch menu, select API Console.
This API Console is different from the Dev Tools Console available in Kibana, from which you can call Elasticsearch and Kibana APIs. On the Elasticsearch API Console, you cannot run Kibana APIs.
This API console is intended for admin purposes. Avoid running normal workload like indexing or search requests.
Elastic Cloud Hosted Serverless Unavailable
Elastic Cloud Control (ECCTL) is the command-line interface for Elastic Cloud APIs. It wraps typical operations commonly needed by operators within a single command line tool.
ECCTL provides the following benefits:
- Easier to use than the Elastic Cloud Console, Cloud UI, or using the RESTful API directly
- Helps you automate the deployment lifecycle
- Provides a foundation for integration with other tools
Find more details in the ECCTL documentation.
Elastic Cloud Hosted Serverless Unavailable
The Elastic Cloud Terraform provider allows you to provision and manage Elastic Cloud Hosted and Elastic Cloud Enterprise deployments as code, and introduce DevOps-driven methodologies to manage and deploy the Elastic Stack and solutions.
To get started, see the Elastic Cloud Terraform provider documentation.