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.

« Create cluster Get cluster »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.4] ›RESTful API ›API reference ›Clusters - Apm - CRUD

Delete cluster

edit

Delete cluster

edit

Deletes an APM cluster. Requires that you have already successfully issued _shutdown command against the cluster.

Request

edit

DELETE /api/v1/clusters/apm/{cluster_id}

Path parameters

edit
Name Type Required Description

cluster_id

string

Y

The APM deployment identifier.

Responses

edit
200

(EmptyResponse) The APM server is deleted.

404

(BasicFailedReply) The {cluster_id} can't be found. (code: 'clusters.cluster_not_found')

412

(BasicFailedReply) To delete the APM server, you must first shut it down. (code: 'clusters.cluster_plan_state_error')

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 -XDELETE {{hostname}}/api/v1/clusters/apm/{cluster_id} \
-H "Authorization: ApiKey $ECE_API_KEY"
« Create cluster Get cluster »