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.

« Resynchronize cluster Take snapshot »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.1] ›RESTful API ›API reference ›Clusters - Elasticsearch - Commands

Shut down cluster

edit

Shut down cluster

edit

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.

Request

edit

POST /api/v1/clusters/elasticsearch/{cluster_id}/_shutdown

Path parameters

edit
Name Type Required Description

cluster_id

string

Y

The Elasticsearch cluster identifier.

Query parameters

edit
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.

Responses

edit
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 example

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