A newer version is available. For the latest information, see the current release documentation.
Elastic Docs ›Elastic Cloud Enterprise Reference [2.2] ›RESTful API ›API reference ›Clusters - Elasticsearch - Commands
« Resynchronize cluster Take snapshot »

Shut down clusteredit

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 Elasticsearch cluster is shutting down. To monitor progress, use the GET command on the /{cluster_id} resource.

404

(BasicFailedReply) The {cluster_id} can't be found. (code: 'clusters.cluster_not_found')

449

(BasicFailedReply) Elevated permissions are required. (code: '"root.needs_elevated_permissions"')

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request exampleedit

curl -XPOST {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/_shutdown \
-u $CLOUD_USER:$CLOUD_KEY
« Resynchronize cluster Take snapshot »