Shutdown Deployment Stateless Resource

edit

Shutdown Deployment Stateless Resource

edit

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.

Request

edit

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

Path parameters

edit

Name	Type	Required	Description
`deployment_id`	`string`	Y	Identifier for the Deployment.
`ref_id`	`string`	Y	User-specified RefId for the Resource (or '_main' if there is only one).
`stateless_resource_kind`	`string`; allowed values: [`kibana`, `apm`, `appsearch`, `enterprise_search`, `integrations_server`]	Y	The kind of stateless resource

Query parameters

edit

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

Responses

edit

200

(DeploymentResourceCommandResponse)

Standard response

400

(BasicFailedReply)

Parameter is restricted and can only be set by a Platform administrator. (code: deployments.restricted_parameter)

Headers

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

404

(BasicFailedReply)

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)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_not_found, deployments.deployment_resource_not_found]): 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

Request example

edit

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

« Restart Deployment Stateless Resource Upgrade Kibana, APM, Integrations Server, AppSearch, Enterprise Search inside Deployment »