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 all instances
editStop all instances
editStops all of the instances in the Elasticsearch cluster..
Request
editPOST /api/v1/clusters/elasticsearch/{cluster_id}/instances/_stop
Path parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
The Elasticsearch cluster identifier. |
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)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 example
editcurl -XPOST {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/instances/_stop \
-H "Authorization: ApiKey $ECE_API_KEY"