Elasticsearch cluster

Connect your Elasticsearch cluster to SearchAPI — or use one hosted by us.

What is an Elasticsearch Cluster?

An Elasticsearch Cluster is a saved connection to an Elasticsearch cluster. SearchAPI uses this connection to read and write data on your behalf when serving API requests.

You can connect your own self-managed or cloud-hosted Elasticsearch cluster, or use an Elasticsearch cluster provided by SearchAPI. Either way, you register the connection once and then assign it to your APIs.

Prerequisites

  • The Owner or Manager role. Members with the User role do not see this page in the sidebar.

Add a cluster

  1. In the sidebar, go to My Account → Elasticsearch Clusters.
  2. Click the Add button to open the configuration form.
    Elasticsearch Cluster list screenshot Elasticsearch cluster list
  3. Enter a Cluster Name — a free-form label used only to identify the cluster in the dashboard; it is not sent to Elasticsearch.
  4. Select the authentication method that matches your cluster setup:
    Authenticate with user

    Use a username and password to connect to a standard Elasticsearch cluster.

    • Host — full URL of your cluster (e.g. acme.es.us-central1.gcp.cloud.es.io)
    • User — Elasticsearch username
    • Password — Elasticsearch password
    Authenticate with API key

    Use an API key to connect to an Elastic Cloud deployment.

    • Cloud Id — the Cloud ID from your Elastic Cloud deployment
    • Key Id — the ID portion of your API key (optional)
    • Api Key — the secret value of your API key
  5. Fill in the required fields for the chosen authentication method.
    Elasticsearch Cluster form screenshot Elasticsearch cluster form
  6. Click Save.

Result: SearchAPI stores the connection and makes it available when creating APIs.

Manage clusters

All saved clusters are listed on the Elasticsearch Cluster page. From there you can view the connection details, edit the credentials, or delete a cluster that is no longer needed. A cluster cannot be deleted while it is assigned to an active API.

Last updated: October 30, 2026