Restores a shutdown resource

POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/_restore

Auth

Restores a shutdown resource belonging to a given Deployment.

Path parameters

deployment_id string required: Identifier for the Deployment
resource_kind enum required: The kind of resource; Values: elasticsearch kibana apm appsearch enterprise_search integrations_server
ref_id string required: User-specified RefId for the Resource (or '_main' if there is only one)

Query parameters

restore_snapshot boolean · default: false: Whether or not to restore a snapshot for those resources that allow it.

Responses

Standard Deployment Resource Crud Response

application/json

id string required: The id of the deployment
kind string required: The kind of the stateless resource
ref_id string required: The reference id of the resource

The Resource does not have a pending plan. (code: deployments.resource_does_not_have_a_pending_plan)
The resource is not shut down. (code: deployments.resource_not_shutdown)

application/json

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

application/json

Examples

Request curl 1 / 1 language

curl Shell

curl -X POST "${API_URL}/deployments/${DEPLOYMENT_ID}/elasticsearch/${REF_ID}/_restore" \
  -u "${USERNAME}:${PASSWORD}"

Generated from the API spec

Response

{
  "id": "string",
  "kind": "string",
  "ref_id": "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