Show Menu
Search…
Ctrl+K
ESC
Example searches: “Api key”, “from”, “calm_wait_time”, “Basic auth”, “preferred_allocators”
Toggle dark mode
Elastic APIs hub
Elastic Cloud API
Elastic Cloud Enterprise API
Elastic Cloud Serverless API
Elasticsearch API
Elasticsearch Serverless API
Kibana API
Kibana Serverless API
Observability Intake Serverless API
Back to hub page
API Changelog
Download source
JSON OpenAPI specification
YAML OpenAPI specification
Topics
Introduction
Authentication
Endpoints
Accounts
Fetch current account information
GET
Updates the current account
PUT
Updates the current account
PATCH
Authentication
User authentication information
GET
Login to ECE
POST
Logout from ECE
POST
Refresh authentication token
POST
Get all API keys
GET
Create API key
POST
Delete API keys
DELETE
Get all API keys for all users
GET
Delete API keys of multiple users
DELETE
Get API key
GET
Delete API key
DELETE
Available authentication methods
GET
SAML callback
POST
Initiate SAML protocol
GET
Get API key metadata for all keys created by the user
GET
Delete API keys for a user
DELETE
Get a user API key
GET
Delete an API key for a user
DELETE
Billing costs analysis
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.
GET
Comments
List Comments
GET
Create a Comment
POST
Get Comment
GET
Update Comment
PUT
Delete Comment
DELETE
Deployments
List Deployments
GET
Create Deployment
POST
Resynchronize Deployments
POST
Search Deployments
POST
Get eligible remote clusters
POST
Get Deployment
GET
Update Deployment
PUT
Delete Deployment
DELETE
Restores a shutdown Deployment
POST
Resynchronize Deployment
POST
Shuts down Deployment
POST
Get Deployment APM Resource Info
GET
Reset the secret token for an APM resource.
POST
Get Deployment App Search Resource Info
GET
Set AppSearch read-only status
GET
Set AppSearch read-only status
PUT
Get certificate authority
GET
Get Deployment Elasticsearch Resource Info
GET
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
Get eligible remote clusters
POST
Move Elasticsearch resource instances
POST
Get the items in the Elasticsearch resource keystore
GET
Add or remove items from the Elasticsearch resource keystore
PATCH
Get certificate based remote clusters
GET
Set certificate based remote clusters
PUT
Get the depedencies of Elasticsearch resource snapshot
GET
Delete a dependency of Elasticsearch resource snapshot
DELETE
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 Deployment upgade assistant status
GET
Restores a shutdown resource
POST
Get plan activity
GET
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)
POST
Set size overrides
PUT
Start instances
POST
Stop instances
POST
Start maintenance mode
POST
Stop maintenance mode
POST
Set size overrides
PUT
Capture a new on-demand heap dump for the given instance
POST
Download the given instance's heap dump
GET
Capture a new thread dump for the given instance
POST
Set a Deployment's resource metadata
POST
Cancel resource pending plan
DELETE
Proxy HTTP GET request
GET
Proxy HTTP PUT request
PUT
Proxy HTTP POST request
POST
Proxy HTTP DELETE request
DELETE
Delete Stateless Resource from Deployment
DELETE
Restart Deployment Stateless Resource
POST
Shutdown Deployment Stateless Resource
POST
Upgrade Kibana, APM, Integrations Server, AppSearch, Enterprise Search inside Deployment
POST
Deployments - Extensions
List Extensions
GET
Create an extension
POST
Get Extension
GET
Uploads the Extension
PUT
Update Extension
POST
Delete Extension
DELETE
Deployments - Templates
Get deployment templates
GET
Create deployment template
POST
Get deployment template
GET
Set deployment template
PUT
Delete deployment template
DELETE
Deployments - Traffic filters
Get associated rulesets
GET
List traffic filter claimed link id
GET
Claim a link id
POST
Unclaims a link id
POST
List traffic filter rulesets
GET
Create a ruleset
POST
Retrieves the ruleset by ID.
GET
Updates a ruleset
PUT
Delete a ruleset
DELETE
Get associated deployments
GET
Create ruleset association
POST
Delete ruleset association
DELETE
Networking - Deployment Domain Names
Get default Deployment Domain Name
GET
Set default Deployment Domain Name
PUT
Get Deployment Domain Name for a resource kind
GET
Set Deployment Domain Name for a resource kind.
PUT
Organizations
List organizations
GET
Get organization invitation
GET
Accept an organization invitation
POST
Fetch organization information
GET
Update organization
PUT
List organization invitations
GET
Create organization invitations
POST
Delete organization invitations
DELETE
List organization members
GET
Delete organization memberships
DELETE
Platform
Get platform info
GET
List extra certificates
GET
Read extra certificate
GET
Update extra certificate
PUT
Delete extra certificate
DELETE
Platform - Configuration - Instances - CRUD
Get instance configurations
GET
Create instance configuration
POST
Get instance configuration
GET
Set instance configuration
PUT
Delete a instance configuration
DELETE
Platform - Configuration - Security
Get current security deployment
GET
Update security deployment
PUT
Create security deployment
POST
Get enrollment tokens
GET
Create enrollment token
POST
Delete enrollment token
DELETE
List security realm configurations
GET
Reorder security realms
POST
Create Active Directory configuration
POST
Get Active Directory configuration
GET
Update Active Directory configuration
PUT
Delete Active Directory configuration
DELETE
Create LDAP configuration
POST
Get LDAP configuration
GET
Update LDAP configuration
PUT
Delete LDAP configuration
DELETE
Create SAML configuration
POST
Get SAML configuration
GET
Update SAML configuration
PUT
Delete SAML configuration
DELETE
Get TLS certificate
GET
Set TLS certificate
POST
Platform - Configuration - Trust relationships
List trust relationships
GET
Create trust relationship
POST
Get trust relationship
GET
Update trust relationship
PUT
Delete trust relationship
DELETE
Platform - Infrastructure
Get API base Url
GET
Set API base Url
PUT
List Config Store Option
GET
Find Config Store Option by name
GET
Update Config Store Option
PUT
Create Config Store Option
POST
Delete Config Store Option by name
DELETE
Get adminconsoles
GET
Reindex region indices
POST
Get adminconsole logging settings
GET
Set adminconsole logging settings
PUT
Delete adminconsole logging settings
DELETE
Update adminconsole logging settings
PATCH
Get allocators
GET
Resynchronize allocators
POST
Search allocators
POST
Get allocator
GET
Delete allocator
DELETE
Resynchronize allocator
POST
Move clusters
POST
Move clusters by type
POST
Get allocator logging settings
GET
Set allocator logging settings
PUT
Delete allocator logging settings
DELETE
Update allocator logging settings
PATCH
Start maintenance mode
POST
Stop maintenance mode
POST
Get allocator metadata
GET
Set allocator metadata
PUT
Set allocator metadata item
PUT
Delete allocator metadata item
DELETE
Get allocator settings
GET
Set allocator settings
PUT
Update allocator settings
PATCH
List roles
GET
Create a role
POST
Get role
GET
Update role
PUT
Delete role
DELETE
Set blessings
PUT
Add Blessing
PUT
Get constructors
GET
Resynchronize constructors
POST
Get constructor
GET
Resynchronize constructor
POST
Get constructor logging settings
GET
Set constructor logging settings
PUT
Delete constructor logging settings
DELETE
Update constructor logging settings
PATCH
Start maintenance mode
POST
Stop maintenance mode
POST
Get coordinators
GET
Get coordinator candidates
GET
Get a coordinator candidate
GET
Delete coordinator candidate
DELETE
Promote a coordinator candidate
POST
Get a coordinator
GET
Demote a coordinator
POST
Get proxies
GET
Create filtered group of proxies
POST
Get filtered group of proxies
GET
Update filtered group of proxies
PUT
Delete filtered group of proxies
DELETE
Get health for a filtered group of proxies
GET
Get proxy health
GET
Get proxies settings
GET
Set proxy settings
PUT
Update proxy settings
PATCH
Get proxy
GET
Get runners
GET
Resynchronize runners
POST
Search runners
POST
Get runner
GET
Delete runner
DELETE
Resynchronize runner
POST
Get runner logging settings
GET
Set runner logging settings
PUT
Delete runner logging settings
DELETE
Update runner logging settings
PATCH
Set runner roles
PUT
Get license
GET
Add or update license
PUT
Delete license
DELETE
Platform - Repository - CRUD
Get snapshot repositories
GET
Get snapshot repository
GET
Set snapshot repository
PUT
Delete snapshot repository
DELETE
Stack - Versions - CRUD
Get instance types
GET
Get stack versions
GET
Upload stack pack
POST
Get stack version
GET
Update stack version
PUT
Delete stack version
DELETE
Telemetry
Get ECE telemetry config
GET
Set ECE telemetry config
PUT
Templates - Deployments - Global
Get all templates cross region.
GET
Trusted environments
Get trusted environments
GET
Users
Fetch current user information
GET
Updates the current user
PATCH
Fetch all users
GET
Creates a new user
POST
Fetch a single user
GET
Deletes an existing user
DELETE
Updates an existing user
PATCH
Dismiss highlight
Show more
Platform - Configuration - Security