Stop all instancesedit

Stops all of the instances in the 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.

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. (code: clusters.command_prohibited)

Headers

x-cloud-error-codes (string; allowed values: [clusters.command_prohibited])
The error codes associated with the response
404

(BasicFailedReply) The cluster specified by {cluster_id} cannot be found. (code: clusters.cluster_not_found)

Headers

x-cloud-error-codes (string; allowed values: [clusters.cluster_not_found])
The error codes associated with the response
449

(BasicFailedReply) Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

Headers

x-cloud-error-codes (string; allowed values: [root.unauthorized.rbac.elevated_permissions_required])
The error codes associated with the response

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 \
-H "Authorization: ApiKey $ECE_API_KEY"