Access the Elasticsearch API

Interact with a specific Elasticsearch cluster directly from the Elasticsearch Add-On for Heroku console 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 Elasticsearch Add-On for Heroku platform changes from the Elasticsearch API.

  1. Log into the Elasticsearch Add-On for Heroku console.
  2. On the Deployments page, select your deployment.

    Narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list.

  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.

    Tip

    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.