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.

« Start instances Start maintenance mode »

› › › ›

Stop instances

edit

Stop instances

edit

Stops the instances in the Elasticsearch cluster.

Request

edit

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

Path parameters

edit

Name	Type	Required	Description
`cluster_id`	`string`	Y	The Elasticsearch cluster identifier.
`instance_ids`	`array[string]`	Y	A comma-separated list of instance identifiers.

Query parameters

edit

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.

Responses

edit

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. (code: clusters.command_prohibited)
404: (BasicFailedReply) * The cluster specified by {cluster_id} cannot be found. (code: clusters.cluster_not_found) * 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.unauthorized.rbac.elevated_permissions_required)

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

Request example

edit

curl -XPOST {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/instances/{instance_ids}/_stop \
-u $CLOUD_USER:$CLOUD_KEY

« Start instances Start maintenance mode »