Search & Analytics API Key

Elastic Cloud REST API

Managed Elasticsearch for search and analytics at scale

Elastic Cloud provides fully managed Elasticsearch, Kibana, and Observability solutions for search, logging, and analytics. Developers use it to build powerful search experiences, monitor applications, analyze logs, and gain real-time insights from data at scale. The REST API enables programmatic management of deployments, clusters, and integrations.

Base URL https://api.elastic-cloud.com/api/v1

API Endpoints

Method	Endpoint	Description
GET	`/deployments`	List all Elastic Cloud deployments in your organization
POST	`/deployments`	Create a new Elastic Cloud deployment with specified configuration
GET	`/deployments/{deployment_id}`	Get details about a specific deployment including health and resources
PUT	`/deployments/{deployment_id}`	Update deployment configuration, scale resources, or change settings
DELETE	`/deployments/{deployment_id}`	Delete a deployment and all associated resources
POST	`/deployments/{deployment_id}/_shutdown`	Gracefully shutdown a deployment without deleting it
POST	`/deployments/{deployment_id}/_restore`	Restore a deployment from a snapshot backup
GET	`/deployments/{deployment_id}/elasticsearch/{ref_id}/snapshots`	List all snapshots for an Elasticsearch cluster
POST	`/deployments/{deployment_id}/elasticsearch/{ref_id}/snapshots`	Create a snapshot backup of an Elasticsearch cluster
GET	`/platform/infrastructure/allocators`	Get information about infrastructure allocators and capacity
GET	`/users/auth/_current`	Get information about the currently authenticated user
GET	`/deployments/{deployment_id}/notes`	Retrieve deployment notes and annotations
POST	`/deployments/{deployment_id}/notes`	Add notes or annotations to a deployment
GET	`/stack/versions`	List available Elastic Stack versions for deployment
GET	`/deployments/{deployment_id}/apm/{ref_id}/settings`	Get APM server settings for a deployment

Code Examples

curl -X GET 'https://api.elastic-cloud.com/api/v1/deployments' \
  -H 'Authorization: ApiKey YOUR_API_KEY' \
  -H 'Content-Type: application/json'

const response = await fetch('https://api.elastic-cloud.com/api/v1/deployments', {
  method: 'GET',
  headers: {
    'Authorization': 'ApiKey YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});

const deployments = await response.json();
console.log(deployments);

import requests

url = 'https://api.elastic-cloud.com/api/v1/deployments'
headers = {
    'Authorization': 'ApiKey YOUR_API_KEY',
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
deployments = response.json()
print(deployments)

Connect Elastic Cloud to AI

Deploy a Elastic Cloud MCP server on IOX Cloud and connect it to Claude, ChatGPT, Cursor, or any AI client. Your AI assistant gets direct access to Elastic Cloud through these tools:

create_elastic_deployment Create and configure a new Elastic Cloud deployment with specified stack versions and resource allocations

query_deployment_health Check the health status and performance metrics of Elastic Cloud deployments

manage_deployment_snapshots Create, list, and restore snapshots for Elasticsearch clusters to enable backup and recovery

scale_deployment_resources Automatically scale Elasticsearch cluster resources based on usage patterns or requirements

monitor_cluster_metrics Retrieve and analyze cluster performance metrics, node statistics, and resource utilization

Deploy in 60 seconds

Describe what you need, AI generates the code, and IOX deploys it globally.

Deploy Elastic Cloud MCP Server →

Elastic Cloud REST API

API Endpoints

Code Examples

Connect Elastic Cloud to AI

Deploy in 60 seconds

Related APIs