It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Update Deployment Shuts down Deployment »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.12] ›RESTful API ›API reference ›Deployment - CRUD

Restores a shutdown Deployment

edit

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. (code: deployments.deployment_not_found)

Headers

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

Request example

edit
curl -XPOST https://{{hostname}}/api/v1/deployments/{deployment_id}/_restore \
-H "Authorization: ApiKey $ECE_API_KEY"
« Update Deployment Shuts down Deployment »