Elastic Cloud Enterprise API
This RESTful API enables you to create and manage both your Elastic Stack deployments and the ECE platform.
NOTE: This documentation applies to the Elastic Cloud Enterprise API only. If you are using Elasticsearch Service, use the Elastic Cloud API.
This API supports both key-based and token-based authentication. Key-based is generally the preferred method. For details about creating an API key or bearer token, refer to Authentication.
NOTE: In this documentation, {{hostname}} refers to the coordinating host (any host with the coordinator role). You can specify either its hostname or its IP address.
This documentation applies to Elastic Cloud Enterprise version 4.2. It is derived from https://api.elastic-cloud.com/api/v1/api-docs/swagger.json. It is provided under license Attribution-NonCommercial-NoDerivatives 4.0 International.
Accounts 3
Authentication 18
- GET User authentication information
- POST Login to ECE
- POST Logout from ECE
- POST Refresh authentication token
- GET Get all API keys
- POST Create API key
- DELETE Delete API keys
- GET Get all API keys for all users
- DELETE Delete API keys of multiple users
- GET Get API key
- DELETE Delete API key
- GET Available authentication methods
- POST SAML callback
- GET Initiate SAML protocol
- GET Get API key metadata for all keys created by the user
- DELETE Delete API keys for a user
- GET Get a user API key
- DELETE Delete an API key for a user
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.
Comments 5
Deployments 73
- GET List Deployments
- POST Create Deployment
- POST Resynchronize Deployments
- POST Search Deployments
- POST Get eligible remote clusters
- POST Get eligible remote clusters
- GET Get Deployment
- PUT Update Deployment
- DELETE Delete Deployment
- POST Restores a shutdown Deployment
- POST Resynchronize 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
- POST Move Elasticsearch resource instances
- 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 details about heap dumps for a Deployment
- 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
- GET Get plan activity
- POST Capture diagnostics for an Elasticsearch or Kibana resource
- POST Start all instances
- POST Stop all instances
- POST Start maintenance mode (all instances)
- POST Stop maintenance mode (all instances)
- PUT Set size overrides
- PUT Set size overrides
- POST Start instances
- POST Stop instances
- POST Start maintenance mode
- POST Stop maintenance mode
- POST Capture a new on-demand heap dump for the given instance
- GET Download the given instance's heap dump
- POST Capture a new thread dump for the given instance
- POST Set a Deployment's resource metadata
- PATCH Patch a Deployment's resource metadata
- DELETE Cancel resource pending plan
- GET Proxy HTTP GET request
- POST Proxy HTTP POST request
- PUT Proxy HTTP PUT request
- DELETE Proxy HTTP DELETE request
- GET Get the user settings of a Deployment resource
- PUT Update user settings for a deployment resource
- DELETE Delete Stateless Resource from Deployment
- POST Restart Deployment Stateless Resource
- POST Shutdown Deployment Stateless Resource
Deployments - Extensions 6
Deployments - Templates 5
Deployments - Traffic filters 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
Networking - Deployment Domain Names 4
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
Platform 5
Platform - Configuration - Instances - CRUD 5
Platform - Configuration - Security 22
- GET Get current security deployment
- POST Create security deployment
- PUT Update security deployment
- GET Get enrollment tokens
- POST Create enrollment token
- DELETE Delete enrollment token
- GET List security realm configurations
- POST Reorder security realms
- POST Create Active Directory configuration
- GET Get Active Directory configuration
- PUT Update Active Directory configuration
- DELETE Delete Active Directory configuration
- POST Create LDAP configuration
- GET Get LDAP configuration
- PUT Update LDAP configuration
- DELETE Delete LDAP configuration
- POST Create SAML configuration
- GET Get SAML configuration
- PUT Update SAML configuration
- DELETE Delete SAML configuration
- GET Get TLS certificate
- POST Set TLS certificate
Platform - Configuration - Trust relationships 5
Platform - Infrastructure 83
- GET Get API base Url
- PUT Set API base Url
- GET List Config Store Option
- GET Find Config Store Option by name
- POST Create Config Store Option
- PUT Update Config Store Option
- DELETE Delete Config Store Option by name
- GET Get adminconsoles
- POST Reindex region indices
- GET Get adminconsole logging settings
- PUT Set adminconsole logging settings
- DELETE Delete adminconsole logging settings
- PATCH Update adminconsole logging settings
- GET Get allocators
- POST Resynchronize allocators
- POST Search allocators
- GET Get allocator
- DELETE Delete allocator
- POST Resynchronize allocator
- POST Move clusters
- POST Move clusters by type
- GET Get allocator logging settings
- PUT Set allocator logging settings
- DELETE Delete allocator logging settings
- PATCH Update allocator logging settings
- POST Start maintenance mode
- POST Start maintenance mode
- POST Stop maintenance mode
- POST Stop maintenance mode
- GET Get allocator metadata
- PUT Set allocator metadata
- PUT Set allocator metadata item
- DELETE Delete allocator metadata item
- GET Get allocator settings
- PUT Set allocator settings
- PATCH Update allocator settings
- GET List roles
- POST Create a role
- GET Get role
- PUT Update role
- DELETE Delete role
- PUT Set blessings
- PUT Add Blessing
- GET Get constructors
- POST Resynchronize constructors
- GET Get constructor
- POST Resynchronize constructor
- GET Get constructor logging settings
- PUT Set constructor logging settings
- DELETE Delete constructor logging settings
- PATCH Update constructor logging settings
- GET Get coordinators
- GET Get coordinator candidates
- GET Get a coordinator candidate
- DELETE Delete coordinator candidate
- POST Promote a coordinator candidate
- GET Get a coordinator
- POST Demote a coordinator
- GET Get proxies
- POST Create filtered group of proxies
- GET Get filtered group of proxies
- PUT Update filtered group of proxies
- DELETE Delete filtered group of proxies
- GET Get health for a filtered group of proxies
- GET Get proxy health
- GET Get proxies settings
- PUT Set proxy settings
- PATCH Update proxy settings
- GET Get proxy
- GET Get runners
- POST Resynchronize runners
- POST Search runners
- GET Get runner
- DELETE Delete runner
- POST Resynchronize runner
- GET Get runner logging settings
- PUT Set runner logging settings
- DELETE Delete runner logging settings
- PATCH Update runner logging settings
- PUT Set runner roles
- GET Get license
- PUT Add or update license
- DELETE Delete license