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.
Shuts down Deploymentedit
Shuts down all resources in a Deployment.
Requestedit
POST /api/v1/deployments/{deployment_id}/_shutdown
Path parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
Identifier for the Deployment |
Query parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
N |
Whether or not to hide the deployment and its resources |
|
|
N |
Whether or not to skip snapshots before shutting down the resources |
Responsesedit
-
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
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request exampleedit
curl -XPOST {{hostname}}/api/v1/deployments/{deployment_id}/_shutdown \
-H "Authorization: ApiKey $ECE_API_KEY"