Cloud ID & API keys

To connect securely to Elasticsearch on Serverless or in Elastic Cloud, you need two essential pieces of information: your Cloud ID and an API key. The Cloud ID identifies your project or deployment and simplifies client configuration, while the API key provides secure authentication without exposing your username and password.

This page explains how to locate your Cloud ID and how to create an API key in both Serverless projects and Elastic Cloud deployments. Follow the instructions below for your environment.

Finding your Cloud ID

To authenticate against the Elasticsearch service you are going to need the Cloud ID that was assigned to your project or deployment.

Follow these steps to obtain your Cloud ID of your project:

  1. Navigate to your Elastic Cloud home page.
  2. Locate your Servelress project, and click Open under the Actions column.
  3. Select the Help icon in the top right corner and then select Connection Details.
  4. Toggle the Show Cloud ID option to view the Cloud ID. Refer to the following screenshot as a reference.

Follow these steps to obtain the Cloud ID of your deployment:

  1. Navigate to your Elastic Cloud home page.
  2. Locate your deployment, and click Manage under the Actions column.
  3. The Cloud ID is displayed on the right side of the page. Refer to the following screenshot as a reference.

Creating an API Key

For security purposes, it is recommended that you create an API Key to use when authenticating to the Elasticsearch service.

Follow these steps to create an API Key for your project:

  • Navigate to your Elastic Cloud home page.
  • Locate your Servelress project, and click Open under the Actions column.
  • Select + API keys.
  • Enter the API key details, and select Create API key.
  • Copy and securely store the API key, because it only appears once.

Follow these steps to create an API Key for your deployment:

  • Navigate to your Elastic Cloud home page.
  • Locate your deployment or fully managed Elasticsearch project and click the Open link under the Actions column.
  • On the left-side menu bar, click on Stack Management under Management.
  • Open API keys under Security.
  • Click Create an API key.
  • Give a name to the API key and click Create API key.

Copy your encoded API key to the clipboard, and paste it into a local text document for safekeeping until you need to use it.

Previously

Start-local

Ready to build state of the art search experiences?

Sufficiently advanced search isn’t achieved with the efforts of one. Elasticsearch is powered by data scientists, ML ops, engineers, and many more who are just as passionate about search as you are. Let’s connect and work together to build the magical search experience that will get you the results you want.

Try it yourself