Shutdown Deployment Stateless Resource | Elastic Cloud Enterprise Reference [2.4]

A newer version is available. For the latest information, see the current release documentation.

› › › ›

Shutdown Stateless Resource belonging to a given Deployment.

POST /api/v1/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_shutdown

Name	Type	Required	Description
`deployment_id`	`string`	Y	Identifier for the Deployment
`ref_id`	`string`	Y	User-specified RefId for the Resource
`stateless_resource_kind`	`string`; allowed values: [`kibana`, `apm`, `appsearch`]	Y	The kind of stateless resource

Name	Type	Required	Description
`hide`	`boolean`; default: `false`	N	Hide cluster on shutdown. Hidden clusters are not listed by default
`skip_snapshot`	`boolean`; default: `false`	N	If true, will skip taking a snapshot of the cluster before shutting the cluster down (if even possible)

200

(DeploymentResourceCommandResponse) Standard response

404

(BasicFailedReply) The Resource specified by {ref_id} cannot be found. (code: deployments.deployment_resource_not_found)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_resource_not_found]): The error codes associated with the response

449

(BasicFailedReply) Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

Headers

x-cloud-error-codes (string; allowed values: [root.unauthorized.rbac.elevated_permissions_required]): The error codes associated with the response

500

(BasicFailedReply) We have failed you. (code: deployments.deployment_resource_no_longer_exists)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_resource_no_longer_exists]): The error codes associated with the response

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

curl -XPOST {{hostname}}/api/v1/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_shutdown \
-H "Authorization: ApiKey $ECE_API_KEY"