Shutdown Deployment Elasticsearch Resourceedit
Shutdown Elasticsearch Resource belonging to a given Deployment.
Requestedit
POST /api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/_shutdown
Path parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
Identifier for the Deployment |
|
|
Y |
User-specified RefId for the Resource |
Query parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
N |
Hide cluster on shutdown. Hidden clusters are not listed by default |
|
|
N |
If true, will skip taking a snapshot of the cluster before shutting the cluster down (if even possible) |
Responsesedit
-
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 exampleedit
curl -XPOST {{hostname}}/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/_shutdown \
-H "Authorization: ApiKey $ECE_API_KEY"