Shut down clusteredit
DEPRECATED (Scheduled to be removed in the next major version): Shuts down the active Elasticsearch cluster and removes all of the cluster nodes. The cluster plan is retained. WARNING: To avoid data loss, save the data outside of the cluster before you shut the cluster down.
Requestedit
POST /api/v1/clusters/elasticsearch/{cluster_id}/_shutdown
Path parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
The Elasticsearch cluster identifier. |
Query parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
N |
Hides the clusters during shutdown. NOTE: By default, hidden clusters are not listed. |
|
|
N |
When |
Responsesedit
-
202 -
(
ClusterCommandResponse) The shutdown command was issued successfully, use the "GET" command on the /{cluster_id} resource to monitor progress -
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
-
Request exampleedit
curl -XPOST https://{{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/_shutdown \
-H "Authorization: ApiKey $ECE_API_KEY"