Restores a shutdown Deployment

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

Restores all resources in a Deployment.

Path parameters

deployment_id string required

Identifier for the Deployment

Query parameters

restore_snapshot boolean · default: false

Whether or not to restore a snapshot for those resources that allow it.

Responses

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

application/json
id string required

The id of the deployment

There are Elasticsearch resources in the deployment which are not shut down.

application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

You are not authorized to perform this action.

application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

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

application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response

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