It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

Elastic Docs ›Elastic Cloud Enterprise Reference [2.0] ›RESTful API ›API reference ›Clusters - Elasticsearch - Commands
« Start all instances Start maintenance mode all instances »

Stop all instancesedit

Stops the all instances belonging to an Elasticsearch cluster.

Requestedit

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

Path parametersedit

Name Type Required Description

cluster_id

string

Y

The Elasticsearch cluster identifier.

Query parametersedit

Name Type Required Description

ignore_missing

boolean; default: false

N

When true and the instance does not exist, proceeds to the next instance, or treats the instance as an error.

Responsesedit

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"')

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request exampleedit

curl -XPOST {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/instances/_stop \
-u $CLOUD_USER:$CLOUD_KEY
« Start all instances Start maintenance mode all instances »