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.
Stop instancesedit
DEPRECATED (Scheduled to be removed in the next major version): Stops the instances in the Elasticsearch cluster.
Requestedit
POST /api/v1/clusters/elasticsearch/{cluster_id}/instances/{instance_ids}/_stop
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
The Elasticsearch cluster identifier. |
|
|
Y |
A comma-separated list of instance identifiers. |
Query parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
N |
When |
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
) * One or more of the instances specified at {instance_ids} could not be found. (code:clusters.instances_not_found
)Headers
-
x-cloud-error-codes
(string
; allowed values: [clusters.cluster_not_found
,clusters.instances_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
-
Request exampleedit
curl -XPOST https://{{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/instances/{instance_ids}/_stop \ -H "Authorization: ApiKey $ECE_API_KEY"