Skip to main content
POST
/
deployments
/
{deployment_id}
/
_shutdown
Shuts down Deployment
curl --request POST \
  --url https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/_shutdown \
  --header 'Authorization: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "orphaned": {
    "apm": [
      "<string>",
      "<string>"
    ],
    "appsearch": [
      "<string>",
      "<string>"
    ],
    "elasticsearch": [
      {
        "dependents": [
          {
            "id": "<string>",
            "kind": "<string>"
          },
          {
            "id": "<string>",
            "kind": "<string>"
          }
        ],
        "id": "<string>"
      },
      {
        "dependents": [
          {
            "id": "<string>",
            "kind": "<string>"
          },
          {
            "id": "<string>",
            "kind": "<string>"
          }
        ],
        "id": "<string>"
      }
    ],
    "enterprise_search": [
      "<string>",
      "<string>"
    ],
    "integrations_server": [
      "<string>",
      "<string>"
    ],
    "kibana": [
      "<string>",
      "<string>"
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
deployment_id
string
required

(Required) Identifier for the Deployment

Example:

"<string>"

Query Parameters

​
hide
string

Whether or not to hide the deployment and its resources.Only applicable for Platform administrators.

Example:

"<boolean>"

​
skip_snapshot
string

Whether or not to skip snapshots before shutting down the resources

Example:

"false"

Response

The request was valid and the resources of the deployment were shutdown.

​
id
string
Example:

"<string>"

​
name
string
Example:

"<string>"

​
orphaned
object
⌘I