Shuts down Deployment
- Base URL
-
https://api.elastic-cloud.com/api/v1
No auth
Shuts down all resources in a Deployment.
-
deployment_id
string
required
-
Identifier for the Deployment
-
hide
boolean
-
Whether or not to hide the deployment and its resources.Only applicable for Platform administrators.
-
skip_snapshot
boolean · default: false
-
Whether or not to skip snapshots before shutting down the resources
The request was valid and the resources of the deployment were shutdown.
-
id
string
required
-
The id of the deployment
-
name
string
required
-
The name of the deployment
-
orphaned
object
-
Details about orphaned resources.
-
-
elasticsearch
object[]
required
-
List of orphaned Elasticsearch resources
-
-
id
string
required
-
The id of the orphaned resource
-
dependents
object[]
required
-
List of orphaned dependent resources
-
-
id
string
required
-
The id of the orphaned resource
-
kind
string
required
-
The kind of resource
-
kibana
string[]
required
-
List of orphaned Kibana resource ids
-
apm
string[]
required
-
List of orphaned APM resource ids
-
appsearch
string[]
required
-
List of orphaned AppSearch resource ids
-
enterprise_search
string[]
required
-
List of orphaned Enterprise Search resource ids
-
integrations_server
string[]
required
-
List of orphaned Integrations Server resource ids
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
You are not authorized to perform this action.
-
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)
-
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
Thank you for your feedback.