Tools and APIs
Elastic Cloud Hosted Serverless
The following APIs allow you to manage your Elastic Cloud organization, users, security, billing and resources.
You can use the Elastic Cloud Serverless APIs to manage your Elastic Cloud Serverless projects, your organization, and its users.
You can use the Elastic Cloud API to manage your hosted 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.
The following APIs allow you to interact with your Elasticsearch cluster, its data, and the features available to you in your hosted deployment or serverless project.
Note that some restrictions apply when using the these APIs on Elastic Cloud.
API references
The following APIs are available for Elasticsearch Serverless users. These links will take you to the autogenerated API reference documentation.
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.
TipLearn 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.
Additional API information
- Elasticsearch API conventions: Reference information about headers and request body conventions for Elasticsearch Serverless REST APIs.
::::
- 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.
Elastic Cloud Hosted Serverless Unavailable
For each deployment, an API Console page is available from the Elastic Cloud Console for you to execute queries using the available APIs. You can find this console when selecting a specific deployment to manage. From there, the API Console is available under the Elasticsearch page.
This API Console is different from the Dev Tools Console available in each deployment, from which you can call Elasticsearch and Kibana APIs. On the Elastic Cloud API Console, you cannot run Kibana APIs.
ecctl is the command-line interface for Elastic Cloud APIs. It wraps typical operations commonly needed by operators within a single command line tool.
Benefits of ecctl:
- Easier to use than the 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
AutoOps significantly simplifies cluster management for your Elastic Cloud Hosted deployments with performance recommendations, resource utilization visibility, real-time issue detection and resolution paths. Find more details in AutoOps
Elastic Cloud Hosted Serverless Unavailable
The Elastic Cloud Terraform provider allows you to provision Elastic Cloud Hosted deployments on any Elastic Cloud platform, whether it’s Elastic Cloud or Elastic Cloud Enterprise.
The provider lets you manage Elastic Cloud 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.