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.
Shut down clusteredit
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.
Requestedit
POST /api/v1/clusters/apm/{cluster_id}/_shutdown
Path parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
The APM deployment identifier. |
Query parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
N |
Hides the clusters during shutdown. NOTE: By default, hidden clusters are not listed. |
Responsesedit
-
202 -
(
ClusterCommandResponse) The APM server is shutting down. To monitor progress, use theGETcommand 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/apm/{cluster_id}/_shutdown \
-u $CLOUD_USER:$CLOUD_KEY