Shutdown Deployment Stateless Resource
Base URL
https://api.elastic-cloud.com/api/v1
No auth
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.
Expand all
deployment_id
string required
Identifier for the Deployment.
stateless_resource_kind
enum required
The kind of stateless resource
Values:
kibana
apm
appsearch
enterprise_search
integrations_server
ref_id
string required
User-specified RefId for the Resource (or '_main' if there is only one).
hide
boolean
Hide cluster on shutdown. Hidden clusters are not listed by default. Only applicable for Platform administrators.
skip_snapshot
boolean · default: false
If true, will skip taking a snapshot of the cluster before shutting the cluster down (if even possible)
warnings
object []
List of warnings generated from validating command
+
Show 2 properties
code
string required
A structured code representing the error type that occurred
message
string
A human readable message describing the warning that occurred
400
Parameter is restricted and can only be set by a Platform administrator. (code: deployments.restricted_parameter)
application/json
errors
object [] required
A list of errors that occurred in the failing request
−
Hide 3 properties
code
string required
A structured code representing the error type that occurred
message
string required
A human readable message describing the error that occurred
fields
string []
If the error can be tied to a specific field or fields in the user request, this lists those fields
404
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)
application/json
errors
object [] required
A list of errors that occurred in the failing request
−
Hide 3 properties
code
string required
A structured code representing the error type that occurred
message
string required
A human readable message describing the error that occurred
fields
string []
If the error can be tied to a specific field or fields in the user request, this lists those fields
500
We have failed you. (code: deployments.deployment_resource_no_longer_exists)
application/json
errors
object [] required
A list of errors that occurred in the failing request
−
Hide 3 properties
code
string required
A structured code representing the error type that occurred
message
string required
A human readable message describing the error that occurred
fields
string []
If the error can be tied to a specific field or fields in the user request, this lists those fields