Delete clusteredit
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 -
(
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 exampleedit
curl -XDELETE {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id} \
-H "Authorization: ApiKey $ECE_API_KEY"