IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Stop all instancesedit
This endpoint is deprecated and scheduled to be removed in the next major version. Use stop all resource instances instead.
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 |
|---|---|---|---|
|
|
Y |
The Elasticsearch cluster identifier. |
Responsesedit
-
202 -
The stop command was issued successfully, use the "GET" command on the /{cluster_id} resource to monitor progress
-
403 -
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 -
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 -
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
-
Request exampleedit
curl -XPOST https://{{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/instances/_stop \
-H "Authorization: ApiKey $ECE_API_KEY"