Shutdown Deployment Stateless Resource
https://api.elastic-cloud.com/api/v1
- POST /deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_shutdown
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
-
deployment_idstringrequired -
Identifier for the Deployment.
-
stateless_resource_kind -
The kind of stateless resource
-
Values:
kibanaapmappsearchenterprise_searchintegrations_server -
ref_idstringrequired -
User-specified RefId for the Resource (or '_main' if there is only one).
Query Parameters
-
hideboolean Hide cluster on shutdown. Hidden clusters are not listed by default. Only applicable for Platform administrators.
-
skip_snapshotboolean · default: false If true, will skip taking a snapshot of the cluster before shutting the cluster down (if even possible)
Responses
Standard response
Parameter is restricted and can only be set by a Platform administrator. (code: deployments.restricted_parameter)
-
errorsBasicFailedReplyElementrequired -
A list of errors that occurred in the failing request
Response Headers
-
x-cloud-error-codes The error codes associated with the response
- 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)
-
errorsBasicFailedReplyElementrequired -
A list of errors that occurred in the failing request
Response Headers
-
x-cloud-error-codes The error codes associated with the response
We have failed you. (code: deployments.deployment_resource_no_longer_exists)
-
errorsBasicFailedReplyElementrequired -
A list of errors that occurred in the failing request
Response Headers
-
x-cloud-error-codes The error codes associated with the response