It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Migrate to index lifecycle management Work with snapshots »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.9] ›Administering deployments

Access the Elasticsearch API console

edit

Access the Elasticsearch API console

edit

Interact with a specific Elasticsearch cluster directly from the 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 are unable to make Elastic Cloud Enterprise platform changes from the Elasticsearch API. If you want to work with the platform, see the Elastic Cloud Enterprise RESTful API.

  1. Log into the Cloud UI.

  2. On the deployments page, select your deployment.

    Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters.

  3. From the Elasticsearch menu, go to the API Console page.

  4. Make a selection from the operation drop-down list and complete the path.

    For example, select GET, then use the _cluster/health?pretty=true path for cluster status and other pertinent details.

  5. If needed, add the body information.

    To display the body area, select PUT, POST, or DELETE from the drop-down list.

  6. Click Submit.

The results of the API operation are displayed, along with the time it took to complete the operation.

To learn more about what kinds of Elasticsearch API calls you can make from the Cloud UI, see the Elasticsearch Reference.

« Migrate to index lifecycle management Work with snapshots »