IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
Elastic Docs ›Elastic Cloud Enterprise Reference [2.13] ›RESTful API ›API reference ›Clusters - Elasticsearch - Commands
« Resynchronize cluster Take snapshot »

Shut down clusteredit

This endpoint is deprecated and scheduled to be removed in the next major version. Use shutdown Elasticsearch resource instead.

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

cluster_id

string

Y

The Elasticsearch cluster identifier.

Query parametersedit

Name Type Required Description

hide

boolean; default: false

N

Hides the clusters during shutdown. NOTE: By default, hidden clusters are not listed.

skip_snapshot

boolean; default: false

N

When true, skips the snapshot when the cluster is shut down.

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"
« Resynchronize cluster Take snapshot »