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 Deployment Get Deployment »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.12] ›RESTful API ›API reference ›Deployment - CRUD

Delete Deployment

edit

Delete Deployment

edit

Deletes a Deployment and all its resources.

Request

edit

DELETE /api/v1/deployments/{deployment_id}

Path parameters

edit
Name Type Required Description

deployment_id

string

Y

Identifier for the Deployment

Responses

edit
200

(DeploymentDeleteResponse) The request was valid and the deployment was deleted.

400

(BasicFailedReply) The Deployment resources have not been shutdown yet.

401

(BasicFailedReply) You are not authorized to perform this action.

404

(BasicFailedReply) The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)

Headers

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

Request example

edit
curl -XDELETE https://{{hostname}}/api/v1/deployments/{deployment_id} \
-H "Authorization: ApiKey $ECE_API_KEY"
« Create Deployment Get Deployment »