Docs
Elastic Cloud Enterprise Reference [2.0] » API Reference » Clusters - Elasticsearch - Commands » Stop instances
«  Start instances     Start maintenance mode  »

Stop instances

Stops the instances belonging to an Elasticsearch cluster.

Request

POST /api/v1/clusters/elasticsearch/{cluster_id}/instances/{instance_ids}/_stop

Path parameters

cluster_id (required)
(string) The Elasticsearch cluster identifier.
instance_ids (required)
(array[string]) A comma-separated list of instance identifiers.

Query parameters

ignore_missing
(boolean; default: false) When true and the instance does not exist, proceeds to the next instance, or treats the instance as an error.

Responses

202
(ClusterCommandResponse) The stop command was issued successfully, use the "GET" command on the /{cluster_id} resource to monitor progress
403
(BasicFailedReply) The stop command was prohibited for the given cluster
404
(BasicFailedReply) One or more of the instances specified at {instance_ids} could not be found (code: 'clusters.instances_not_found')
449
(BasicFailedReply) elevated permissions are required. (code: '"root.needs_elevated_permissions"')
«  Start instances     Start maintenance mode  »