A newer version is available. For the latest information, see the
current release documentation.
Delete clusteredit
This endpoint is deprecated and scheduled to be removed in the next major version. Use delete deployment instead.
Deletes the Elasticsearch cluster.
Before you delete the Elasticsearch cluster, you must first successfully issue a _shutdown
command.
Requestedit
DELETE /api/v1/clusters/elasticsearch/{cluster_id}
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
The Elasticsearch cluster identifier. |
Responsesedit
-
200
-
The cluster has been successfully deleted
-
404
-
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
-
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
-
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
-
Request exampleedit
curl -XDELETE https://{{hostname}}/api/v1/clusters/elasticsearch/{cluster_id} \ -H "Authorization: ApiKey $ECE_API_KEY"