Stop instances

» » »

Stops the instances belonging to an Elasticsearch cluster.

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

cluster_id (required): (string) Identifier for the Elasticsearch cluster
instance_ids (required): (string) Optional comma-delimited list of instance identifiers of the Elasticsearch cluster, otherwise will apply to all instances

ignore_missing: (boolean; default: false) If true and the instance does not exist then quietly proceed to the next instance, otherwise treated as an error

202: (EmptyResponse) 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) When running as an administrator (other than root), sudo is required (code: 'root.needs_sudo')