Shuts down Deployment

Shuts down all resources in a Deployment.

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

Name	Type	Required	Description
`deployment_id`	`string`	Y	Identifier for the Deployment

Name	Type	Required	Description
`hide`	`boolean`	N	Whether or not to hide the deployment and its resources.Only applicable for Platform administrators.
`skip_snapshot`	`boolean`; default: `false`	N	Whether or not to skip snapshots before shutting down the resources

200

(DeploymentShutdownResponse)

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

400

(BasicFailedReply)

Parameter is restricted and can only be set by a Platform administrator. (code: deployments.restricted_parameter)

Headers

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

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

curl -XPOST https://{{hostname}}/api/v1/deployments/{deployment_id}/_shutdown \
-H "Authorization: ApiKey $ECE_API_KEY"