Shutdown Deployment Elasticsearch Resource
- Base URL
-
https://api.elastic-cloud.com/api/v1
No auth
Shutdown Elasticsearch Resource belonging to a given Deployment.
-
deployment_id
string
required
-
Identifier for the Deployment.
-
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
-
-
code
string
required
-
A structured code representing the error type that occurred
-
message
string
-
A human readable message describing the warning that occurred
Parameter is restricted and can only be set by a Platform administrator. (code: deployments.restricted_parameter)
-
errors
object[]
required
-
A list of errors that occurred in the failing request
-
-
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
- 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)
-
errors
object[]
required
-
A list of errors that occurred in the failing request
-
-
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
A Resource that was previously stored no longer exists. (code: deployments.deployment_resource_no_longer_exists)
-
errors
object[]
required
-
A list of errors that occurred in the failing request
-
-
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