Shuts down Deployment

Base URL: https://api.elastic-cloud.com/api/v1

POST /deployments/{deployment_id}/_shutdown

No auth

Shuts down all resources in a Deployment.

Path parameters

deployment_id string required: Identifier for the Deployment

Query parameters

hide boolean: Whether or not to hide the deployment and its resources.Only applicable for Platform administrators.
skip_snapshot boolean · default: false: Whether or not to skip snapshots before shutting down the resources

Responses

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

application/json

id string required: The id of the deployment
name string required: The name of the deployment
orphaned object: Details about orphaned resources.

Parameter is restricted and can only be set by a Platform administrator. (code: deployments.restricted_parameter)

application/json

You are not authorized to perform this action.

application/json

The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)

application/json

Base URL: https://api.elastic-cloud.com/api/v1

Examples

Request curl 1 / 1 language

curl Shell

curl -X POST "https://api.elastic-cloud.com/api/v1/deployments/${DEPLOYMENT_ID}/_shutdown"

Generated from the API spec

Response

{
  "id": "string",
  "name": "string",
  "orphaned": {
    "elasticsearch": [
      {
        "id": "string",
        "dependents": [
          {
            "id": "string",
            "kind": "string"
          }
        ]
      }
    ],
    "kibana": [
      "string"
    ],
    "apm": [
      "string"
    ],
    "appsearch": [
      "string"
    ],
    "enterprise_search": [
      "string"
    ],
    "integrations_server": [
      "string"
    ]
  }
}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec