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.
-
hide -
(
boolean; default:false) Hide cluster on shutdown. Hidden clusters are not listed by default -
skip_snapshot -
(
boolean; default:false) If true, will skip taking a snapshot of the cluster before shutting the cluster down (if even possible)
-
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"')