Elastic Cloud RESTful API
A RESTful API is available with Elastic Cloud, allowing you to perform most of the operations available in the UI console through API calls.
You can create an API key to quickly and easily authenticate, and then use the API to create and manage deployments, configure remote clusters, set up traffic filters, manage extensions, and much more. Access the API from its base URL at api.elastic-cloud.com
.
This section contains the following information to supplement the Elastic Cloud and Elastic Cloud Serverless API reference information:
- Principles - The basics of how the RESTful API works
- Access and authentication - How to obtain an API key
- Rate limiting - Time limits and quotas for API calls
- Accessing the API - Different methods for you to use the API
- API examples - Several examples to help you get started
To get started using the Elasticsearch Service API, either directly or through the Elastic Cloud Control (ecctl) CLI, try out this introductory guide.
The Elasticsearch Service API is documented using the OpenAPI specification. The current supported version of the specification is 2.0
. View the documentation at https://www.elastic.co/docs/api/doc/cloud.
A machine readable specification is available at https://api.elastic-cloud.com/api/v1/api-docs-user/swagger.json.
When using the API, use api.elastic-cloud.com
as the host for all endpoints (for example, use https://api.elastic-cloud.com/api/v1/deployments
and not https://cloud.elastic.co/api/v1/deployments
).