Shut down cluster

» » »

« Resynchronize cluster Immediately create a new cluster snapshot »

Shuts down a running cluster and removes all nodes belonging to the cluster. The plan for the cluster is retained. Warning: this will lose all cluster data that is not saved in a snapshot repository.

Request

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

Path parameters

cluster_id (required): (string) The Elasticsearch cluster identifier.

Query parameters

hide: (boolean; default: false) Hides the clusters during shutdown. NOTE: By default, hidden clusters are not listed.
skip_snapshot: (boolean; default: false) When true, skips the snapshot when the cluster is shut down.

Responses

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')
449: (BasicFailedReply) elevated permissions are required. (code: '"root.needs_elevated_permissions"')