Elastic Cloud API

deployments-{deployment id}-elasticsearch/{ref id}-remote-clusters

Set remote clusters Get remote clusters

deployments-{deployment id}-elasticsearch/{ref id}-keystore

Add or remove settings from the Elasticsearch resource keystore Get the settings from the Elasticsearch resource keystore

deployments-{deployment id}-elasticsearch/{ref id}

Get Deployment Elasticsearch Resource Info Shutdown Deployment Elasticsearch Resource Restart Deployment Elasticsearch Resource Migrate Elasticsearch resource to use SLM Reset 'elastic' user password Migrate Elasticsearch and associated Kibana resources to enable CCR Get eligible remote clusters Migrate Elasticsearch resource to use ILM

deployments-{deployment id}-{resource kind}/{ref id}-instances-{instance ids}-maintenance-mode

Start maintenance mode Stop maintenance mode

deployments-{deployment id}-{resource kind}/{ref id}-instances-{instance ids}

Stop instances Start instances

deployments-{deployment id}-{resource kind}/{ref id}-instances-maintenance-mode

Start maintenance mode (all instances)Stop maintenance mode (all instances)

deployments-{deployment id}-{resource kind}/{ref id}-instances

Start all instances Stop all instances

deployments-{deployment id}-{resource kind}/{ref id}

Restores a shutdown resource Cancel resource pending plan

deployments-{deployment id}-apm/{ref id}

Get Deployment APM Resource Info Reset the secret token for an APM resource.

deployments-{deployment id}-appsearch/{ref id}-read only mode

Set AppSearch read-only status Set AppSearch read-only status

deployments-{deployment id}-appsearch/{ref id}

Get Deployment App Search Resource Info

deployments-{deployment id}-{stateless resource kind}/{ref id}

Restart Deployment Stateless Resource Shutdown Deployment Stateless Resource Upgrade Kibana, APM, AppSearch inside Deployment

deployments-{deployment id}

Update Deployment Get Deployment Restores a shutdown Deployment Get Deployment Enterprise Search Resource Info Get Deployment Kibana Resource Info Shuts down Deployment Build Migrate Deployment Template request

deployments-templates

Get deployment templates Get deployment template

deployments-traffic-filter-rulesets-{ruleset id}-associations

Create ruleset association Get associated deployments Delete ruleset association

deployments-traffic-filter-rulesets-{ruleset id}

Updates a ruleset Delete a ruleset Retrieves the ruleset by ID.

deployments-traffic-filter-rulesets

Create a ruleset List traffic filter rulesets

deployments-traffic-filter

Get associated rulesets

deployments-extensions-{extension id}

Uploads the Extension Update Extension Delete Extension Get Extension

deployments-extensions

Create an extension List Extensions

Create Deployment List Deployments Search Deployments Get eligible remote clusters

users/auth/keys-{api key id}

Delete API key Get API key

users/auth/keys

Create API key Delete API keys Get all API keys

Updates the current account Updates the current account Fetch current account information

platform/configuration/trust-relationships-{trust relationship id}

Update trust relationship Delete trust relationship Get trust relationship

platform/configuration/trust-relationships

Create trust relationship List trust relationships

Get stack versions

Elastic Cloud API

deployments-{deployment id}-elasticsearch/{ref id}-remote-clusters

Set remote clusters Get remote clusters

deployments-{deployment id}-elasticsearch/{ref id}-keystore

Add or remove settings from the Elasticsearch resource keystore Get the settings from the Elasticsearch resource keystore

deployments-{deployment id}-elasticsearch/{ref id}

Get Deployment Elasticsearch Resource Info Shutdown Deployment Elasticsearch Resource Restart Deployment Elasticsearch Resource Migrate Elasticsearch resource to use SLM Reset 'elastic' user password Migrate Elasticsearch and associated Kibana resources to enable CCR Get eligible remote clusters Migrate Elasticsearch resource to use ILM

deployments-{deployment id}-{resource kind}/{ref id}-instances-{instance ids}-maintenance-mode

Start maintenance mode Stop maintenance mode

deployments-{deployment id}-{resource kind}/{ref id}-instances-{instance ids}

Stop instances Start instances

deployments-{deployment id}-{resource kind}/{ref id}-instances-maintenance-mode

Start maintenance mode (all instances)Stop maintenance mode (all instances)

deployments-{deployment id}-{resource kind}/{ref id}-instances

Start all instances Stop all instances

deployments-{deployment id}-{resource kind}/{ref id}

Restores a shutdown resource Cancel resource pending plan

deployments-{deployment id}-apm/{ref id}

Get Deployment APM Resource Info Reset the secret token for an APM resource.

deployments-{deployment id}-appsearch/{ref id}-read only mode

Set AppSearch read-only status Set AppSearch read-only status

deployments-{deployment id}-appsearch/{ref id}

Get Deployment App Search Resource Info

deployments-{deployment id}-{stateless resource kind}/{ref id}

Restart Deployment Stateless Resource Shutdown Deployment Stateless Resource Upgrade Kibana, APM, AppSearch inside Deployment

deployments-{deployment id}

Update Deployment Get Deployment Restores a shutdown Deployment Get Deployment Enterprise Search Resource Info Get Deployment Kibana Resource Info Shuts down Deployment Build Migrate Deployment Template request

deployments-templates

Get deployment templates Get deployment template

deployments-traffic-filter-rulesets-{ruleset id}-associations

Create ruleset association Get associated deployments Delete ruleset association

deployments-traffic-filter-rulesets-{ruleset id}

Updates a ruleset Delete a ruleset Retrieves the ruleset by ID.

deployments-traffic-filter-rulesets

Create a ruleset List traffic filter rulesets

deployments-traffic-filter

Get associated rulesets

deployments-extensions-{extension id}

Uploads the Extension Update Extension Delete Extension Get Extension

deployments-extensions

Create an extension List Extensions

Create Deployment List Deployments Search Deployments Get eligible remote clusters

users/auth/keys-{api key id}

Delete API key Get API key

users/auth/keys

Create API key Delete API keys Get all API keys

Updates the current account Updates the current account Fetch current account information

platform/configuration/trust-relationships-{trust relationship id}

Update trust relationship Delete trust relationship Get trust relationship

platform/configuration/trust-relationships

Create trust relationship List trust relationships

Get stack versions

Home Elastic Cloud API users/auth/keys-{api key id}Get API key

Get API key

GET {{baseUrl}}/users/auth/keys/:api_key_id

Retrieves the metadata for an API key.

RESPONSES

status: OK

&quot;&quot;

users/auth/keys