Shutdown Deployment Stateless Resource
Shut down Stateless Resource belonging to a given Deployment. Kibana cannot be shut down on Elasticsearch Service as it is required for Elasticsearch administrative functions, such as Snapshot Lifecycle Management and version upgrades.
Path parameters
-
Identifier for the Deployment.
-
The kind of stateless resource
Values are
kibana
,apm
,appsearch
,enterprise_search
, orintegrations_server
. -
User-specified RefId for the Resource (or '_main' if there is only one).
Query parameters
-
hide boolean
Hide cluster on shutdown. Hidden clusters are not listed by default. Only applicable for Platform administrators.
-
skip_snapshot boolean
If true, will skip taking a snapshot of the cluster before shutting the cluster down (if even possible)
Default value is
false
.
Responses
-
Standard response
-
Parameter is restricted and can only be set by a Platform administrator. (code:
deployments.restricted_parameter
) -
- The Deployment specified by {deployment_id} cannot be found. (code:
deployments.deployment_not_found
) - The Resource specified by {ref_id} cannot be found. (code:
deployments.deployment_resource_not_found
)
- The Deployment specified by {deployment_id} cannot be found. (code:
-
We have failed you. (code:
deployments.deployment_resource_no_longer_exists
)
curl \
-X POST https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_shutdown
{
"warnings": [
{
"code": "string",
"message": "string"
}
]
}
# Headers
x-cloud-error-codes: deployments.restricted_parameter
# Payload
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"string"
]
}
]
}
# Headers
x-cloud-error-codes: deployments.deployment_not_found
# Payload
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"string"
]
}
]
}
# Headers
x-cloud-error-codes: deployments.deployment_resource_no_longer_exists
# Payload
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"string"
]
}
]
}