Elastic Cloud API
The Elastic Cloud control-plane API creates, scales, upgrades and deletes Elasticsearch and Kibana deployments, and manages accounts, organizations, IAM, traffic filters, extensions, deployment templates and billing costs — 190 paths and 297 operations, published as Swagger 2.0 straight from the live control plane at api.elastic-cloud.com.
Operations 297
Showing the first 250 of 297. The full set is in the contract, and via get_provider_operations.
GET
/billing/costs/{organization_id}
Get costs overview for the organization. Currently unavailable in self-hosted ECE.
#
GET
/billing/costs/{organization_id}/charts
Get charts for the organization. Currently unavailable in self-hosted ECE.
#
GET
/billing/costs/{organization_id}/deployments
Get deployments costs for the organization. Currently unavailable in self-hosted ECE.
#
GET
/billing/costs/{organization_id}/deployments/{deployment_id}/charts
Get charts by deployment. Currently unavailable in self-hosted ECE.
#
GET
/billing/costs/{organization_id}/deployments/{deployment_id}/items
Get itemized costs by deployments. Currently unavailable in self-hosted ECE.
#
GET
/billing/costs/{organization_id}/items
Get itemized costs for the organization. Currently unavailable in self-hosted ECE.
#
GET
/deployments/traffic-filter/associations/{association_type}/{associated_entity_id}/rulesets
Get associated rulesets
#
DELETE
/deployments/traffic-filter/rulesets/{ruleset_id}/associations/{association_type}/{associated_entity_id}
Delete ruleset association
#
POST
/deployments/{deployment_id}/apm/{ref_id}/_reset-token
Reset the secret token for an APM resource.
#
GET
/deployments/{deployment_id}/elasticsearch/{ref_id}
Get Deployment Elasticsearch Resource Info
#
POST
/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ccr
Migrate Elasticsearch and associated Kibana resources to enable CCR
#
POST
/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ilm
Migrate Elasticsearch resource to use ILM
#
POST
/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-slm
Migrate Elasticsearch resource to use SLM
#
POST
/deployments/{deployment_id}/elasticsearch/{ref_id}/_reset-password
Reset 'elastic' user password
#
POST
/deployments/{deployment_id}/elasticsearch/{ref_id}/_restart
Restart Deployment Elasticsearch Resource
#
POST
/deployments/{deployment_id}/elasticsearch/{ref_id}/_shutdown
Shutdown Deployment Elasticsearch Resource
#
POST
/deployments/{deployment_id}/elasticsearch/{ref_id}/eligible-remote-clusters
Get eligible remote clusters
#
POST
/deployments/{deployment_id}/elasticsearch/{ref_id}/instances/{instance_ids}/_move
Move Elasticsearch resource instances
#
GET
/deployments/{deployment_id}/elasticsearch/{ref_id}/keystore
Get the items in the Elasticsearch resource keystore
#
PATCH
/deployments/{deployment_id}/elasticsearch/{ref_id}/keystore
Add or remove items from the Elasticsearch resource keystore
#
GET
/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters
Get certificate based remote clusters
#
PUT
/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters
Set certificate based remote clusters
#
GET
/deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository
List the attached snapshot repositories
#
POST
/deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository
Create a snapshot repository for Elasticsearch resource
#
DELETE
/deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository/{repository_name}
Remove the attached snapshot repository
#
GET
/deployments/{deployment_id}/enterprise_search/{ref_id}
Get Deployment Enterprise Search Resource Info
#
GET
/deployments/{deployment_id}/integrations_server/{ref_id}
Get Deployment Integrations Server Resource Info
#
GET
/deployments/{deployment_id}/migrate_template
Build request to migrate deployment to a different template
#
POST
/deployments/{deployment_id}/{resource_kind}/{ref_id}/diagnostics/_capture
Capture diagnostics for an Elasticsearch or Kibana resource
#
POST
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/maintenance-mode/_start
Start maintenance mode (all instances)
#
POST
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/maintenance-mode/_stop
Stop maintenance mode (all instances)
#
POST
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_start
Start instances
#
POST
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_stop
Stop instances
#
POST
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_start
Start maintenance mode
#
POST
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_stop
Stop maintenance mode
#
PUT
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/overrides
Set size overrides
#
POST
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/heap_dump/_capture
Capture a new on-demand heap dump for the given instance
#
GET
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/heap_dump/_download
Download the given instance's heap dump
#
POST
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/thread_dump/_capture
Capture a new thread dump for the given instance
#
POST
/deployments/{deployment_id}/{resource_kind}/{ref_id}/metadata/raw
Set a Deployment's resource metadata
#
PATCH
/deployments/{deployment_id}/{resource_kind}/{ref_id}/metadata/raw
Patch a Deployment's resource metadata
#
DELETE
/deployments/{deployment_id}/{resource_kind}/{ref_id}/plan/pending
Cancel resource pending plan
#
GET
/deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path}
Proxy HTTP GET request
#
POST
/deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path}
Proxy HTTP POST request
#
PUT
/deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path}
Proxy HTTP PUT request
#
DELETE
/deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path}
Proxy HTTP DELETE request
#
GET
/deployments/{deployment_id}/{resource_kind}/{ref_id}/user_settings
Get the user settings of a Deployment resource
#
PUT
/deployments/{deployment_id}/{resource_kind}/{ref_id}/user_settings
Update user settings for a deployment resource
#
DELETE
/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}
Delete Stateless Resource from Deployment
#
POST
/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_restart
Restart Deployment Stateless Resource
#
POST
/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_shutdown
Shutdown Deployment Stateless Resource
#
POST
/organizations/{organization_id}/domains/_generate_verification_code
Generate verification code
#
GET
/organizations/{organization_id}/idp/metadata.xml
Get organization service provider SAML2 metadata.xml for configuring the identity provider
#
DELETE
/organizations/{organization_id}/invitations/{invitation_tokens}
Delete organization invitations
#
GET
/platform/configuration/networking/deployment_domain_name/{resource_kind}
Get Deployment Domain Name for a resource kind
#
PUT
/platform/configuration/networking/deployment_domain_name/{resource_kind}
Set Deployment Domain Name for a resource kind.
#
POST
/platform/configuration/security/realms/active-directory
Create Active Directory configuration
#
GET
/platform/configuration/security/realms/active-directory/{realm_id}
Get Active Directory configuration
#
PUT
/platform/configuration/security/realms/active-directory/{realm_id}
Update Active Directory configuration
#
DELETE
/platform/configuration/security/realms/active-directory/{realm_id}
Delete Active Directory configuration
#
DELETE
/platform/configuration/snapshots/repositories/{repository_name}
Delete snapshot repository
#
DELETE
/platform/configuration/trust-relationships/{trust_relationship_id}
Delete trust relationship
#
GET
/platform/infrastructure/adminconsoles/{adminconsole_id}/logging_settings
Get adminconsole logging settings
#
PUT
/platform/infrastructure/adminconsoles/{adminconsole_id}/logging_settings
Set adminconsole logging settings
#
DELETE
/platform/infrastructure/adminconsoles/{adminconsole_id}/logging_settings
Delete adminconsole logging settings
#
PATCH
/platform/infrastructure/adminconsoles/{adminconsole_id}/logging_settings
Update adminconsole logging settings
#
POST
/platform/infrastructure/allocators/{allocator_id}/clusters/{cluster_type}/_move
Move clusters by type
#
GET
/platform/infrastructure/allocators/{allocator_id}/logging_settings
Get allocator logging settings
#
PUT
/platform/infrastructure/allocators/{allocator_id}/logging_settings
Set allocator logging settings
#
DELETE
/platform/infrastructure/allocators/{allocator_id}/logging_settings
Delete allocator logging settings
#
PATCH
/platform/infrastructure/allocators/{allocator_id}/logging_settings
Update allocator logging settings
#
POST
/platform/infrastructure/allocators/{allocator_id}/maintenance-mode/_start
Start maintenance mode
#
POST
/platform/infrastructure/allocators/{allocator_id}/maintenance-mode/_stop
Stop maintenance mode
#
DELETE
/platform/infrastructure/allocators/{allocator_id}/metadata/{key}
Delete allocator metadata item
#
PUT
/platform/infrastructure/blueprinter/roles/{blueprinter_role_id}/blessings/{runner_id}
Add Blessing
#
GET
/platform/infrastructure/constructors/{constructor_id}/logging_settings
Get constructor logging settings
#
PUT
/platform/infrastructure/constructors/{constructor_id}/logging_settings
Set constructor logging settings
#
DELETE
/platform/infrastructure/constructors/{constructor_id}/logging_settings
Delete constructor logging settings
#
PATCH
/platform/infrastructure/constructors/{constructor_id}/logging_settings
Update constructor logging settings
#
POST
/platform/infrastructure/constructors/{constructor_id}/maintenance-mode/_start
Start maintenance mode
#
POST
/platform/infrastructure/constructors/{constructor_id}/maintenance-mode/_stop
Stop maintenance mode
#
GET
/platform/infrastructure/coordinators/candidates/{coordinator_candidate_id}
Get a coordinator candidate
#
DELETE
/platform/infrastructure/coordinators/candidates/{coordinator_candidate_id}
Delete coordinator candidate
#
POST
/platform/infrastructure/coordinators/candidates/{coordinator_candidate_id}/_promote
Promote a coordinator candidate
#
GET
/platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id}
Get filtered group of proxies
#
PUT
/platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id}
Update filtered group of proxies
#
DELETE
/platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id}
Delete filtered group of proxies
#
GET
/platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id}/health
Get health for a filtered group of proxies
#
Documentation
📖
Documentation
https://www.elastic.co/docs/deploy-manage/deploy/elastic-cloud
📖
APIReference
https://www.elastic.co/docs/api/doc/cloud/
Other Resources
🔗
Swagger
https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/openapi/_original/elk-stack-elastic-cloud-swagger.json
🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/overlays/elk-stack-elastic-cloud-overlay.yaml
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/apis.yml