Shuts down Deployment
Shuts down all resources in a Deployment.
Path parameters
-
Identifier for the Deployment
Query parameters
-
hide boolean
Whether or not to hide the deployment and its resources.Only applicable for Platform administrators.
-
skip_snapshot boolean
Whether or not to skip snapshots before shutting down the resources
Default value is
false
.
Responses
-
The request was valid and the resources of the deployment were shutdown.
-
Parameter is restricted and can only be set by a Platform administrator. (code:
deployments.restricted_parameter
) -
You are not authorized to perform this action.
-
The Deployment specified by {deployment_id} cannot be found. (code:
deployments.deployment_not_found
)
POST /deployments/{deployment_id}/_shutdown
curl \
-X POST https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/_shutdown
Response examples (200)
{
"id": "string",
"name": "string",
"orphaned": {
"elasticsearch": [
{
"id": "string",
"dependents": [
{
"id": "string",
"kind": "string"
}
]
}
],
"kibana": [
"string"
],
"apm": [
"string"
],
"appsearch": [
"string"
],
"enterprise_search": [
"string"
],
"integrations_server": [
"string"
]
}
}
Response examples (400)
# Headers
x-cloud-error-codes: deployments.restricted_parameter
# Payload
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"string"
]
}
]
}
Response examples (401)
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"string"
]
}
]
}
Response examples (404)
# Headers
x-cloud-error-codes: deployments.deployment_not_found
# Payload
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"string"
]
}
]
}