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.

« Search clusters that can be used as cross-cluster search remotes Get cluster »

› › › ›

Delete cluster

edit

Delete cluster

edit

Deletes the Elasticsearch cluster. Before you delete the Elasticsearch cluster, you must first successfully issue a _shutdown command.

Request

edit

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

Path parameters

edit

Name	Type	Required	Description
`cluster_id`	`string`	Y	The Elasticsearch cluster identifier.

Responses

edit

200

(EmptyResponse) The cluster has been successfully deleted

404

(BasicFailedReply) The cluster specified by {cluster_id} cannot be found. (code: clusters.cluster_not_found)

Headers

x-cloud-error-codes (string; allowed values: [clusters.cluster_not_found]): The error codes associated with the response

412

(BasicFailedReply) The Elasticsearch cluster has not been shutdown yet. (code: clusters.cluster_plan_state_error)

Headers

x-cloud-error-codes (string; allowed values: [clusters.cluster_plan_state_error]): The error codes associated with the response

449

(BasicFailedReply) Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

Headers

x-cloud-error-codes (string; allowed values: [root.unauthorized.rbac.elevated_permissions_required]): The error codes associated with the response

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/elasticsearch/{cluster_id} \
-H "Authorization: ApiKey $ECE_API_KEY"

« Search clusters that can be used as cross-cluster search remotes Get cluster »