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; 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)

Responses

edit
200

(DeploymentResourceCommandResponse) Standard response

401

(BasicFailedReply) You are not authorized to perform this action

404

(BasicFailedReply) The Deployment specified by {deployment_id} cannot be found

500

(BasicFailedReply) We have failed you.

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

Request example

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