A newer version is available. For the latest information, see the
current release documentation.
Restores a shutdown Deployment
edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.
Restores a shutdown Deployment
editRestores all resources in a Deployment.
Request
editPOST /api/v1/deployments/{deployment_id}/_restore
Path parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
Identifier for the Deployment |
Query parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
N |
Whether or not to restore a snapshot for those resources that allow it. |
Responses
edit-
200 -
The request was valid and the resources of the deployment were restored.
-
400 -
There are Elasticsearch resources in the deployment which are not shut down.
-
401 -
You are not authorized to perform this action.
-
404 -
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
editcurl -XPOST https://{{hostname}}/api/v1/deployments/{deployment_id}/_restore \
-H "Authorization: ApiKey $ECE_API_KEY"