Shutdown Deployment Elasticsearch Resource

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

POST /deployments/{deployment_id}/elasticsearch/{ref_id}/_shutdown

No auth

Shutdown Elasticsearch Resource belonging to a given Deployment.

Path parameters

deployment_id string required: Identifier for the Deployment.
ref_id string required: User-specified RefId for the Resource (or '_main' if there is only one).

Query parameters

hide boolean: Hide cluster on shutdown. Hidden clusters are not listed by default. Only applicable for Platform administrators.
skip_snapshot boolean · default: false: If true, will skip taking a snapshot of the cluster before shutting the cluster down (if even possible).

Responses

Standard response.

application/json

warnings object[]: List of warnings generated from validating command

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

application/json

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

application/json

A Resource that was previously stored no longer exists. (code: deployments.deployment_resource_no_longer_exists)

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}/elasticsearch/${REF_ID}/_shutdown"

Generated from the API spec

Response

{
  "warnings": [
    {
      "code": "string",
      "message": "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