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.
/billing/costs/{organization_id} -
GET
Get charts for the organization. Currently unavailable in self-hosted ECE.
/billing/costs/{organization_id}/charts -
GET
Get deployments costs for the organization. Currently unavailable in self-hosted ECE.
/billing/costs/{organization_id}/deployments -
GET
Get charts by deployment. Currently unavailable in self-hosted ECE.
/billing/costs/{organization_id}/deployments/{deployment_id}/charts -
GET
Get itemized costs by deployments. Currently unavailable in self-hosted ECE.
/billing/costs/{organization_id}/deployments/{deployment_id}/items -
GET
Get itemized costs for the organization. Currently unavailable in self-hosted ECE.
/billing/costs/{organization_id}/items
Deployments 54
-
GET
List Deployments
/deployments -
POST
Create Deployment
/deployments -
POST
Search Deployments
/deployments/_search -
POST
Get eligible remote clusters
/deployments/eligible-remote-clusters -
GET
Get Deployment
/deployments/{deployment_id} -
PUT
Update Deployment
/deployments/{deployment_id} -
POST
Restores a shutdown Deployment
/deployments/{deployment_id}/_restore -
POST
Shuts down Deployment
/deployments/{deployment_id}/_shutdown -
GET
Get Deployment APM Resource Info
/deployments/{deployment_id}/apm/{ref_id} -
POST
Reset the secret token for an APM resource.
/deployments/{deployment_id}/apm/{ref_id}/_reset-token -
GET
Get Deployment App Search Resource Info
/deployments/{deployment_id}/appsearch/{ref_id} -
GET
Set AppSearch read-only status
/deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode -
PUT
Set AppSearch read-only status
/deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode -
POST
Migrate Deployment BYOK
/deployments/{deployment_id}/byok-migration -
GET
Get certificate authority
/deployments/{deployment_id}/certificate-authority -
GET
Get Deployment Elasticsearch Resource Info
/deployments/{deployment_id}/elasticsearch/{ref_id} -
POST
Migrate Elasticsearch and associated Kibana resources to enable CCR
/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ccr -
POST
Migrate Elasticsearch resource to use ILM
/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ilm -
POST
Migrate Elasticsearch resource to use SLM
/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-slm -
POST
Reset 'elastic' user password
/deployments/{deployment_id}/elasticsearch/{ref_id}/_reset-password -
POST
Restart Deployment Elasticsearch Resource
/deployments/{deployment_id}/elasticsearch/{ref_id}/_restart -
POST
Shutdown Deployment Elasticsearch Resource
/deployments/{deployment_id}/elasticsearch/{ref_id}/_shutdown -
POST
Get eligible remote clusters
/deployments/{deployment_id}/elasticsearch/{ref_id}/eligible-remote-clusters -
GET
Get the items in the Elasticsearch resource keystore
/deployments/{deployment_id}/elasticsearch/{ref_id}/keystore -
PATCH
Add or remove items from the Elasticsearch resource keystore
/deployments/{deployment_id}/elasticsearch/{ref_id}/keystore -
GET
Get certificate based remote clusters
/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters -
PUT
Set certificate based remote clusters
/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters -
GET
List the attached snapshot repositories
/deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository -
POST
Create a snapshot repository for Elasticsearch resource
/deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository -
DELETE
Remove the attached snapshot repository
/deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository/{repository_name} -
GET
Get Elasticsearch tiers
/deployments/{deployment_id}/elasticsearch/{ref_id}/tiers -
PATCH
Update Elasticsearch tiers
/deployments/{deployment_id}/elasticsearch/{ref_id}/tiers -
GET
Get Deployment Enterprise Search Resource Info
/deployments/{deployment_id}/enterprise_search/{ref_id} -
GET
Get Deployment Integrations Server Resource Info
/deployments/{deployment_id}/integrations_server/{ref_id} -
GET
Get Deployment Kibana Resource Info
/deployments/{deployment_id}/kibana/{ref_id} -
GET
Build request to migrate deployment to a different template
/deployments/{deployment_id}/migrate_template -
GET
Get the tags for a Deployment
/deployments/{deployment_id}/tags -
PUT
Set the tags for a Deployment
/deployments/{deployment_id}/tags -
POST
Upgrade a Deployment to a new Elastic Stack version
/deployments/{deployment_id}/upgrade -
GET
Get Deployment upgrade assistant status
/deployments/{deployment_id}/upgrade_assistant/status -
POST
Restores a shutdown resource
/deployments/{deployment_id}/{resource_kind}/{ref_id}/_restore -
POST
Start all instances
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/_start -
POST
Stop all instances
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/_stop -
POST
Start maintenance mode (all instances)
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/maintenance-mode/_start -
POST
Stop maintenance mode (all instances)
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/maintenance-mode/_stop -
POST
Start instances
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_start -
POST
Stop instances
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_stop -
POST
Start maintenance mode
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_start -
POST
Stop maintenance mode
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_stop -
DELETE
Cancel resource pending plan
/deployments/{deployment_id}/{resource_kind}/{ref_id}/plan/pending -
GET
Get the user settings of a Deployment resource
/deployments/{deployment_id}/{resource_kind}/{ref_id}/user_settings -
PUT
Update user settings for a deployment resource
/deployments/{deployment_id}/{resource_kind}/{ref_id}/user_settings -
POST
Restart Deployment Stateless Resource
/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_restart -
POST
Shutdown Deployment Stateless Resource
/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_shutdown
Deployments - Extensions 6
-
GET
List Extensions
/deployments/extensions -
POST
Create an extension
/deployments/extensions -
GET
Get Extension
/deployments/extensions/{extension_id} -
POST
Update Extension
/deployments/extensions/{extension_id} -
PUT
Uploads the Extension
/deployments/extensions/{extension_id} -
DELETE
Delete Extension
/deployments/extensions/{extension_id}
Deployments - Templates 2
Deployments - Traffic filter 12
-
GET
Get associated rulesets
/deployments/traffic-filter/associations/{association_type}/{associated_entity_id}/rulesets -
GET
List traffic filter claimed link id
/deployments/traffic-filter/link-ids -
POST
Claim a link id
/deployments/traffic-filter/link-ids/_claim -
POST
Unclaims a link id
/deployments/traffic-filter/link-ids/_unclaim -
GET
List traffic filter rulesets
/deployments/traffic-filter/rulesets -
POST
Create a ruleset
/deployments/traffic-filter/rulesets -
GET
Retrieves the ruleset by ID.
/deployments/traffic-filter/rulesets/{ruleset_id} -
PUT
Updates a ruleset
/deployments/traffic-filter/rulesets/{ruleset_id} -
DELETE
Delete a ruleset
/deployments/traffic-filter/rulesets/{ruleset_id} -
GET
Get associated deployments
/deployments/traffic-filter/rulesets/{ruleset_id}/associations -
POST
Create ruleset association
/deployments/traffic-filter/rulesets/{ruleset_id}/associations -
DELETE
Delete ruleset association
/deployments/traffic-filter/rulesets/{ruleset_id}/associations/{association_type}/{associated_entity_id}
Organizations 23
-
GET
List organizations
/organizations -
GET
Get organization invitation
/organizations/invitations/{invitation_token} -
GET
Fetch organization information
/organizations/{organization_id} -
PUT
Update organization
/organizations/{organization_id} -
GET
Get domain claims
/organizations/{organization_id}/domains -
DELETE
Delete domain claim
/organizations/{organization_id}/domains -
POST
Generate verification code
/organizations/{organization_id}/domains/_generate_verification_code -
POST
Verify domain claim
/organizations/{organization_id}/domains/_verify -
GET
Get organization IdP
/organizations/{organization_id}/idp -
PUT
Setup organization IdP
/organizations/{organization_id}/idp -
DELETE
Tear down organization IdP
/organizations/{organization_id}/idp -
GET
Get organization service provider SAML2 metadata.xml for configuring the identity provider
/organizations/{organization_id}/idp/metadata.xml -
GET
List organization invitations
/organizations/{organization_id}/invitations -
POST
Create organization invitations
/organizations/{organization_id}/invitations -
DELETE
Delete organization invitations
/organizations/{organization_id}/invitations/{invitation_tokens} -
GET
List organization members
/organizations/{organization_id}/members -
DELETE
Delete organization memberships
/organizations/{organization_id}/members/{user_ids} -
GET
Get role mappings
/organizations/{organization_id}/role_mappings -
POST
Adds role mapping
/organizations/{organization_id}/role_mappings -
PUT
Updates role mappings
/organizations/{organization_id}/role_mappings -
DELETE
Delete role mappings
/organizations/{organization_id}/role_mappings -
DELETE
Delete role mapping
/organizations/{organization_id}/role_mappings/{role_names} -
PUT
Update role mapping
/organizations/{organization_id}/role_mappings/{role_name}