Skip to main content
POST
/
deployments
/
{deployment_id}
/
elasticsearch
/
{ref_id}
/
_shutdown
Shutdown Deployment Elasticsearch Resource
curl --request POST \
  --url https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/_shutdown \
  --header 'Authorization: <api-key>'
{
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>"
    },
    {
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
deployment_id
string
required

(Required) Identifier for the Deployment.

Example:

"<string>"

​
ref_id
string
required

(Required) User-specified RefId for the Resource (or '_main' if there is only one).

Example:

"<string>"

Query Parameters

​
hide
string

Hide cluster on shutdown. Hidden clusters are not listed by default. Only applicable for Platform administrators.

Example:

"<boolean>"

​
skip_snapshot
string

If true, will skip taking a snapshot of the cluster before shutting the cluster down (if even possible).

Example:

"false"

Response

Standard response.

​
warnings
object[]
Example:
[
  { "code": "<string>", "message": "<string>" },
  { "code": "<string>", "message": "<string>" }
]
⌘I