Restores a shutdown Deployment

Restores all resources in a Deployment.

Request

POST /api/v1/deployments/{deployment_id}/_restore

Path parameters

Name Type Required Description

deployment_id

string

Y

Identifier for the Deployment

Query parameters

Name Type Required Description

restore_snapshot

boolean; default: false

N

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

Responses

200

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

400

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

401

(BasicFailedReply) You are not authorized to perform this action.

404

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

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_not_found])
The error codes associated with the response

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPOST https://{{hostname}}/api/v1/deployments/{deployment_id}/_restore \
-H "Authorization: ApiKey $ECE_API_KEY"