Tools and APIs for Elastic Cloud Enterprise
ECE
Review key resources that can be used to interact with and manage your Elastic Cloud Enterprise installation and deployments.
You can use the following APIs in an Elastic Cloud Enterprise environment.
Refer to API keys to learn how to generate API keys for your environment.
You can use the Elastic Cloud Enterprise RESTful API to manage both your Elastic Stack deployments and the ECE platform.
Refer to Elasticsearch API conventions to learn about headers and request body conventions, and view examples.
The following APIs allow you to interact with your Elasticsearch cluster, its data, and the features available to you in your Elastic Cloud Enterprise deployments.
Refer to Elasticsearch API conventions to learn about headers and request body conventions, and to view examples.
- 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:
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 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.
- ECE scripts: Use these scripts to install Elastic Cloud Enterprise or modify your installation.
- ECE diagnostics tool: Collect logs and metrics related to your ECE installation that you can send to Elastic Support for troubleshooting and investigation purposes.
- Elasticsearch Support Diagnostic tool: Captures a point-in-time snapshot of cluster statistics and most Elasticsearch settings for troubleshooting purposes.