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.
Restores a shutdown Deployment
editRestores a shutdown Deployment
editRestores all resources in a Deployment.
Request
editPOST /api/v1/deployments/{deployment_id}/_restore
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
Identifier for the Deployment |
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
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
editcurl -XPOST {{hostname}}/api/v1/deployments/{deployment_id}/_restore \ -H "Authorization: ApiKey $ECE_API_KEY"