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 resourceedit
Restores a shutdown resource belonging to a given Deployment.
Requestedit
POST /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/_restore
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
Identifier for the Deployment |
|
|
Y |
User-specified RefId for the Resource |
|
|
Y |
The kind of resource |
Query parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
N |
Whether or not to restore a snapshot for those resources that allow it. |
Responsesedit
-
200
-
(
DeploymentResourceCrudResponse
) Standard Deployment Resource Crud Response -
400
-
(
BasicFailedReply
) * The Resource does not have a pending plan. (code:deployments.resource_does_not_have_a_pending_plan
) * The resource is not shut down. (code:deployments.resource_not_shutdown
)Headers
-
x-cloud-error-codes
(string
; allowed values: [deployments.resource_does_not_have_a_pending_plan
,deployments.resource_not_shutdown
]) - The error codes associated with the response
-
-
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
-
-
449
-
(
BasicFailedReply
) Elevated permissions are required. (code:root.unauthorized.rbac.elevated_permissions_required
)Headers
-
x-cloud-error-codes
(string
; allowed values: [root.unauthorized.rbac.elevated_permissions_required
]) - The error codes associated with the response
-
Request exampleedit
curl -XPOST https://{{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/_restore \ -H "Authorization: ApiKey $ECE_API_KEY"