It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Restart Deployment Elasticsearch Resource Start all instances »

› › › ›

Shutdown Deployment Elasticsearch Resource

edit

Shutdown Deployment Elasticsearch Resource

edit

Shutdown Elasticsearch Resource belonging to a given Deployment.

Request

edit

POST /api/v1/deployments/{deployment_id}/elasticsearch/{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.

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) A Resource that was previously stored no longer exists. (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}/elasticsearch/{ref_id}/_shutdown \
-H "Authorization: ApiKey $ECE_API_KEY"

« Restart Deployment Elasticsearch Resource Start all instances »