# Elastic Cloud API ## Description This is version `1` of this API documentation. Last update on Apr 7, 2026. This RESTful API enables you to perform most of the operations available in the UI console through API calls. You can [create an API key](https://www.elastic.co/guide/en/cloud/current/ec-api-authentication.html) to quickly and easily authenticate, then use the API to create and manage deployments, configure remote clusters, set up traffic filters, manage extensions, and much more. Access the API from its base URL at `api.elastic-cloud.com`. To manage your serverless projects, use the [Elastic Cloud Serverless API](https://www.elastic.co/docs/api/doc/elastic-cloud-serverless). ## Documentation source and versions This documentation is derived from https://api.elastic-cloud.com/api/v1/api-docs-user/swagger.json. It is provided under license [Attribution-NonCommercial-NoDerivatives 4.0 International](https://creativecommons.org/licenses/by-nc-nd/4.0/). ## Servers - https://api.elastic-cloud.com/api/v1: https://api.elastic-cloud.com/api/v1 () ## Topics - [Principles](https://www.elastic.co/docs/api/doc/cloud/topic/topic-principles.md) - [Rate limiting](https://www.elastic.co/docs/api/doc/cloud/topic/topic-rate-limiting.md) - [Authentication](https://www.elastic.co/docs/api/doc/cloud/authentication.md) ## Groups and operations ### [Accounts](https://www.elastic.co/docs/api/doc/cloud/group/endpoint-accounts.md) - [Fetch current account information](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-current-account.md) - [Updates the current account](https://www.elastic.co/docs/api/doc/cloud/operation/operation-update-current-account.md) - [Updates the current account](https://www.elastic.co/docs/api/doc/cloud/operation/operation-patch-current-account.md) ### [Authentication](https://www.elastic.co/docs/api/doc/cloud/group/endpoint-authentication.md) - [Get all API keys](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-api-keys.md) - [Create API key](https://www.elastic.co/docs/api/doc/cloud/operation/operation-create-api-key.md) - [Delete API keys](https://www.elastic.co/docs/api/doc/cloud/operation/operation-delete-api-keys.md) - [Get API key](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-api-key.md) - [Delete API key](https://www.elastic.co/docs/api/doc/cloud/operation/operation-delete-api-key.md) ### [Billing costs analysis](https://www.elastic.co/docs/api/doc/cloud/group/endpoint-billingcostsanalysis.md) - [Get costs overview for the organization. Currently unavailable in self-hosted ECE.](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-costs-overview.md) - [Get charts for the organization. Currently unavailable in self-hosted ECE.](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-costs-charts.md) - [Get deployments costs for the organization. Currently unavailable in self-hosted ECE.](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-costs-deployments.md) - [Get charts by deployment. Currently unavailable in self-hosted ECE.](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-costs-charts-by-deployment.md) - [Get itemized costs by deployments. Currently unavailable in self-hosted ECE.](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-costs-items-by-deployment.md) - [Get itemized costs for the organization. Currently unavailable in self-hosted ECE.](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-costs-items.md) ### [Deployments](https://www.elastic.co/docs/api/doc/cloud/group/endpoint-deployments.md) - [List Deployments](https://www.elastic.co/docs/api/doc/cloud/operation/operation-list-deployments.md) - [Create Deployment](https://www.elastic.co/docs/api/doc/cloud/operation/operation-create-deployment.md) - [Search Deployments](https://www.elastic.co/docs/api/doc/cloud/operation/operation-search-deployments.md) - [Get eligible remote clusters](https://www.elastic.co/docs/api/doc/cloud/operation/operation-search-eligible-remote-clusters.md) - [Get Deployment](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-deployment.md) - [Update Deployment](https://www.elastic.co/docs/api/doc/cloud/operation/operation-update-deployment.md) - [Restores a shutdown Deployment](https://www.elastic.co/docs/api/doc/cloud/operation/operation-restore-deployment.md) - [Shuts down Deployment](https://www.elastic.co/docs/api/doc/cloud/operation/operation-shutdown-deployment.md) - [Get Deployment APM Resource Info](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-deployment-apm-resource-info.md) - [Reset the secret token for an APM resource.](https://www.elastic.co/docs/api/doc/cloud/operation/operation-deployment-apm-reset-secret-token.md) - [Get Deployment App Search Resource Info](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-deployment-appsearch-resource-info.md) - [Set AppSearch read-only status](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-appsearch-read-only-mode.md) - [Set AppSearch read-only status](https://www.elastic.co/docs/api/doc/cloud/operation/operation-set-appsearch-read-only-mode.md) - [Get certificate authority](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-deployment-certificate-authority.md) - [Get Deployment Elasticsearch Resource Info](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-deployment-es-resource-info.md) - [Migrate Elasticsearch and associated Kibana resources to enable CCR](https://www.elastic.co/docs/api/doc/cloud/operation/operation-enable-deployment-resource-ccr.md) - [Migrate Elasticsearch resource to use ILM](https://www.elastic.co/docs/api/doc/cloud/operation/operation-enable-deployment-resource-ilm.md) - [Migrate Elasticsearch resource to use SLM](https://www.elastic.co/docs/api/doc/cloud/operation/operation-enable-deployment-resource-slm.md) - [Reset 'elastic' user password](https://www.elastic.co/docs/api/doc/cloud/operation/operation-reset-elasticsearch-user-password.md) - [Restart Deployment Elasticsearch Resource](https://www.elastic.co/docs/api/doc/cloud/operation/operation-restart-deployment-es-resource.md) - [Shutdown Deployment Elasticsearch Resource](https://www.elastic.co/docs/api/doc/cloud/operation/operation-shutdown-deployment-es-resource.md) - [Get eligible remote clusters](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-deployment-es-resource-eligible-remote-clusters.md) - [Get the items in the Elasticsearch resource keystore](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-deployment-es-resource-keystore.md) - [Add or remove items from the Elasticsearch resource keystore](https://www.elastic.co/docs/api/doc/cloud/operation/operation-set-deployment-es-resource-keystore.md) - [Get certificate based remote clusters](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-deployment-es-resource-remote-clusters.md) - [Set certificate based remote clusters](https://www.elastic.co/docs/api/doc/cloud/operation/operation-set-deployment-es-resource-remote-clusters.md) - [List the attached snapshot repositories](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-deployment-es-resource-snapshot-repository.md) - [Create a snapshot repository for Elasticsearch resource](https://www.elastic.co/docs/api/doc/cloud/operation/operation-create-deployment-es-resource-snapshot-repository.md) - [Remove the attached snapshot repository](https://www.elastic.co/docs/api/doc/cloud/operation/operation-delete-deployment-es-resource-snapshot-repository.md) - [Update Elasticsearch tiers](https://www.elastic.co/docs/api/doc/cloud/operation/operation-update-deployment-es-resource-tier.md) - [Get Deployment Enterprise Search Resource Info](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-deployment-enterprise-search-resource-info.md) - [Get Deployment Integrations Server Resource Info](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-deployment-integrations-server-resource-info.md) - [Get Deployment Kibana Resource Info](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-deployment-kib-resource-info.md) - [Build request to migrate deployment to a different template](https://www.elastic.co/docs/api/doc/cloud/operation/operation-migrate-deployment-template.md) - [Get the tags for a Deployment](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-deployment-tags.md) - [Set the tags for a Deployment](https://www.elastic.co/docs/api/doc/cloud/operation/operation-set-deployment-tags.md) - [Get Deployment upgrade assistant status](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-deployment-upgrade-assistant-status.md) - [Restores a shutdown resource](https://www.elastic.co/docs/api/doc/cloud/operation/operation-restore-deployment-resource.md) - [Start all instances](https://www.elastic.co/docs/api/doc/cloud/operation/operation-start-deployment-resource-instances-all.md) - [Stop all instances](https://www.elastic.co/docs/api/doc/cloud/operation/operation-stop-deployment-resource-instances-all.md) - [Start maintenance mode (all instances)](https://www.elastic.co/docs/api/doc/cloud/operation/operation-start-deployment-resource-instances-all-maintenance-mode.md) - [Stop maintenance mode (all instances)](https://www.elastic.co/docs/api/doc/cloud/operation/operation-stop-deployment-resource-instances-all-maintenance-mode.md) - [Start instances](https://www.elastic.co/docs/api/doc/cloud/operation/operation-start-deployment-resource-instances.md) - [Stop instances](https://www.elastic.co/docs/api/doc/cloud/operation/operation-stop-deployment-resource-instances.md) - [Start maintenance mode](https://www.elastic.co/docs/api/doc/cloud/operation/operation-start-deployment-resource-maintenance-mode.md) - [Stop maintenance mode](https://www.elastic.co/docs/api/doc/cloud/operation/operation-stop-deployment-resource-maintenance-mode.md) - [Cancel resource pending plan](https://www.elastic.co/docs/api/doc/cloud/operation/operation-cancel-deployment-resource-pending-plan.md) - [Get the user settings of a Deployment resource](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-deployment-resource-user-settings.md) - [Update user settings for a deployment resource](https://www.elastic.co/docs/api/doc/cloud/operation/operation-update-deployment-resource-user-settings.md) - [Restart Deployment Stateless Resource](https://www.elastic.co/docs/api/doc/cloud/operation/operation-restart-deployment-stateless-resource.md) - [Shutdown Deployment Stateless Resource](https://www.elastic.co/docs/api/doc/cloud/operation/operation-shutdown-deployment-stateless-resource.md) ### [Deployments - Extensions](https://www.elastic.co/docs/api/doc/cloud/group/endpoint-extensions.md) - [List Extensions](https://www.elastic.co/docs/api/doc/cloud/operation/operation-list-extensions.md) - [Create an extension](https://www.elastic.co/docs/api/doc/cloud/operation/operation-create-extension.md) - [Get Extension](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-extension.md) - [Uploads the Extension](https://www.elastic.co/docs/api/doc/cloud/operation/operation-upload-extension.md) - [Update Extension](https://www.elastic.co/docs/api/doc/cloud/operation/operation-update-extension.md) - [Delete Extension](https://www.elastic.co/docs/api/doc/cloud/operation/operation-delete-extension.md) ### [Deployments - Templates](https://www.elastic.co/docs/api/doc/cloud/group/endpoint-deploymenttemplates.md) - [Get deployment templates](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-deployment-templates-v2.md) - [Get deployment template](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-deployment-template-v2.md) ### [Deployments - Traffic filter](https://www.elastic.co/docs/api/doc/cloud/group/endpoint-deploymentstrafficfilter.md) - [Get associated rulesets](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-traffic-filter-deployment-ruleset-associations.md) - [List traffic filter claimed link id](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-traffic-filter-claimed-link-ids.md) - [Claim a link id](https://www.elastic.co/docs/api/doc/cloud/operation/operation-claim-traffic-filter-link-id.md) - [Unclaims a link id](https://www.elastic.co/docs/api/doc/cloud/operation/operation-unclaim-traffic-filter-link-id.md) - [List traffic filter rulesets](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-traffic-filter-rulesets.md) - [Create a ruleset](https://www.elastic.co/docs/api/doc/cloud/operation/operation-create-traffic-filter-ruleset.md) - [Retrieves the ruleset by ID.](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-traffic-filter-ruleset.md) - [Updates a ruleset](https://www.elastic.co/docs/api/doc/cloud/operation/operation-update-traffic-filter-ruleset.md) - [Delete a ruleset](https://www.elastic.co/docs/api/doc/cloud/operation/operation-delete-traffic-filter-ruleset.md) - [Get associated deployments](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-traffic-filter-ruleset-deployment-associations.md) - [Create ruleset association](https://www.elastic.co/docs/api/doc/cloud/operation/operation-create-traffic-filter-ruleset-association.md) - [Delete ruleset association](https://www.elastic.co/docs/api/doc/cloud/operation/operation-delete-traffic-filter-ruleset-association.md) ### [Organizations](https://www.elastic.co/docs/api/doc/cloud/group/endpoint-organizations.md) - [List organizations](https://www.elastic.co/docs/api/doc/cloud/operation/operation-list-organizations.md) - [Get organization invitation](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-organization-invitation.md) - [Accept an organization invitation](https://www.elastic.co/docs/api/doc/cloud/operation/operation-accept-organization-invitation.md) - [Fetch organization information](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-organization.md) - [Update organization](https://www.elastic.co/docs/api/doc/cloud/operation/operation-update-organization.md) - [Get domain claims](https://www.elastic.co/docs/api/doc/cloud/operation/operation-domain-claim-get-domain-claims.md) - [Delete domain claim](https://www.elastic.co/docs/api/doc/cloud/operation/operation-domain-claim-delete.md) - [Generate verification code](https://www.elastic.co/docs/api/doc/cloud/operation/operation-domain-claim-generate-verification-code.md) - [Verify domain claim](https://www.elastic.co/docs/api/doc/cloud/operation/operation-domain-claim-verify-domain.md) - [Get organization IdP](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-organization-idp.md) - [Setup organization IdP](https://www.elastic.co/docs/api/doc/cloud/operation/operation-setup-organization-idp.md) - [Tear down organization IdP](https://www.elastic.co/docs/api/doc/cloud/operation/operation-teardown-organization-idp.md) - [Get organization service provider SAML2 metadata.xml for configuring the identity provider](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-organization-idp-metadata.md) - [List organization invitations](https://www.elastic.co/docs/api/doc/cloud/operation/operation-list-organization-invitations.md) - [Create organization invitations](https://www.elastic.co/docs/api/doc/cloud/operation/operation-create-organization-invitations.md) - [Delete organization invitations](https://www.elastic.co/docs/api/doc/cloud/operation/operation-delete-organization-invitations.md) - [List organization members](https://www.elastic.co/docs/api/doc/cloud/operation/operation-list-organization-members.md) - [Delete organization memberships](https://www.elastic.co/docs/api/doc/cloud/operation/operation-delete-organization-memberships.md) - [Get role mappings](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-role-mappings.md) - [Updates role mappings](https://www.elastic.co/docs/api/doc/cloud/operation/operation-update-role-mappings.md) - [Delete role mappings](https://www.elastic.co/docs/api/doc/cloud/operation/operation-delete-role-mappings.md) ### [Stack - Versions - CRUD](https://www.elastic.co/docs/api/doc/cloud/group/endpoint-stack.md) - [Get stack versions](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-version-stacks.md) ### [Trusted environments](https://www.elastic.co/docs/api/doc/cloud/group/endpoint-trustedenvironments.md) - [Get trusted environments](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-trusted-envs.md) ### [Users - Role Assignments](https://www.elastic.co/docs/api/doc/cloud/group/endpoint-userroleassignments.md) - [Add Role Assignments](https://www.elastic.co/docs/api/doc/cloud/operation/operation-add-role-assignments.md) - [Remove Role Assignments](https://www.elastic.co/docs/api/doc/cloud/operation/operation-remove-role-assignments.md) [Powered by Bump.sh](https://bump.sh)