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.

« Restores a shutdown Deployment Deployment - Commands »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.5] ›RESTful API ›API reference ›Deployment - CRUD

Shuts down Deployment

edit

Shuts down Deployment

edit

Shuts down all resources in a Deployment.

Request

edit

POST /api/v1/deployments/{deployment_id}/_shutdown

Path parameters

edit
Name Type Required Description

deployment_id

string

Y

Identifier for the Deployment

Query parameters

edit
Name Type Required Description

hide

boolean; default: false

N

Whether or not to hide the deployment and its resources

skip_snapshot

boolean; default: false

N

Whether or not to skip snapshots before shutting down the resources

Responses

edit
200

(DeploymentShutdownResponse) The request was valid and the resources of the deployment were shutdown.

400

(BasicFailedReply) The deployment request had errors.

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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

edit
curl -XPOST https://{{hostname}}/api/v1/deployments/{deployment_id}/_shutdown \
-H "Authorization: ApiKey $ECE_API_KEY"
« Restores a shutdown Deployment Deployment - Commands »