Restores a shutdown Deployment

edit

Restores all resources in a Deployment.

Request

edit

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

Path parameters

edit
Name Type Required Description

deployment_id

string

Y

Identifier for the Deployment

Query parameters

edit
Name Type Required Description

restore_snapshot

boolean; default: false

N

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

Responses

edit
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

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

Request example

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