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 Upgrade cluster »

› › › ›

Shut down cluster

edit

Shut down cluster

edit

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

Request

edit

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

Path parameters

edit

Name	Type	Required	Description
`cluster_id`	`string`	Y	The APM deployment 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.

Responses

edit

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.unauthorized.rbac.elevated_permissions_required)

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/apm/{cluster_id}/_shutdown \
-u $CLOUD_USER:$CLOUD_KEY

« Resynchronize cluster Upgrade cluster »