Elastic Cloud API
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 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.
- Base URL
-
https://api.elastic-cloud.com/api/v1 - Version
- 1
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.
Accounts 3
Authentication 5
Billing costs analysis 6
- GET Get costs overview for the organization. Currently unavailable in self-hosted ECE.
- GET Get charts for the organization. Currently unavailable in self-hosted ECE.
- GET Get deployments costs for the organization. Currently unavailable in self-hosted ECE.
- GET Get charts by deployment. Currently unavailable in self-hosted ECE.
- GET Get itemized costs by deployments. Currently unavailable in self-hosted ECE.
- GET Get itemized costs for the organization. Currently unavailable in self-hosted ECE.
Deployments 54
- GET List Deployments
- POST Create Deployment
- POST Search Deployments
- POST Get eligible remote clusters
- POST Get eligible remote clusters
- GET Get Deployment
- PUT Update Deployment
- POST Restores a shutdown Deployment
- POST Shuts down Deployment
- GET Get Deployment APM Resource Info
- POST Reset the secret token for an APM resource.
- GET Get Deployment App Search Resource Info
- GET Set AppSearch read-only status
- PUT Set AppSearch read-only status
- POST Migrate Deployment BYOK
- GET Get certificate authority
- GET Get Deployment Elasticsearch Resource Info
- POST Migrate Elasticsearch and associated Kibana resources to enable CCR
- POST Migrate Elasticsearch resource to use ILM
- POST Migrate Elasticsearch resource to use SLM
- POST Reset 'elastic' user password
- POST Restart Deployment Elasticsearch Resource
- POST Shutdown Deployment Elasticsearch Resource
- GET Get the items in the Elasticsearch resource keystore
- PATCH Add or remove items from the Elasticsearch resource keystore
- GET Get certificate based remote clusters
- PUT Set certificate based remote clusters
- GET List the attached snapshot repositories
- POST Create a snapshot repository for Elasticsearch resource
- DELETE Remove the attached snapshot repository
- GET Get Elasticsearch tiers
- PATCH Update Elasticsearch tiers
- GET Get Deployment Enterprise Search Resource Info
- GET Get Deployment Integrations Server Resource Info
- GET Get Deployment Kibana Resource Info
- GET Build request to migrate deployment to a different template
- GET Get the tags for a Deployment
- PUT Set the tags for a Deployment
- POST Upgrade a Deployment to a new Elastic Stack version
- GET Get Deployment upgrade assistant status
- POST Restores a shutdown resource
- POST Start all instances
- POST Stop all instances
- POST Start maintenance mode (all instances)
- POST Stop maintenance mode (all instances)
- POST Start instances
- POST Stop instances
- POST Start maintenance mode
- POST Stop maintenance mode
- DELETE Cancel resource pending plan
- GET Get the user settings of a Deployment resource
- PUT Update user settings for a deployment resource
- POST Restart Deployment Stateless Resource
- POST Shutdown Deployment Stateless Resource
Deployments - Extensions 6
Deployments - Templates 2
Deployments - Traffic filter 12
- GET Get associated rulesets
- GET List traffic filter claimed link id
- POST Claim a link id
- POST Unclaims a link id
- GET List traffic filter rulesets
- POST Create a ruleset
- GET Retrieves the ruleset by ID.
- PUT Updates a ruleset
- DELETE Delete a ruleset
- GET Get associated deployments
- POST Create ruleset association
- DELETE Delete ruleset association
Organizations 23
- GET List organizations
- GET Get organization invitation
- GET Fetch organization information
- PUT Update organization
- GET Get domain claims
- DELETE Delete domain claim
- POST Generate verification code
- POST Verify domain claim
- GET Get organization IdP
- PUT Setup organization IdP
- DELETE Tear down organization IdP
- GET Get organization service provider SAML2 metadata.xml for configuring the identity provider
- GET List organization invitations
- POST Create organization invitations
- DELETE Delete organization invitations
- GET List organization members
- DELETE Delete organization memberships
- GET Get role mappings
- POST Adds role mapping
- PUT Updates role mappings
- DELETE Delete role mappings
- DELETE Delete role mapping
- PUT Update role mapping