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

deployment_id

string

Y

Identifier for the Deployment

ref_id

string

Y

User-specified RefId for the Resource

resource_kind

string; allowed values: [elasticsearch, kibana, apm, appsearch, enterprise_search]

Y

The kind of resource

Query parametersedit

Name Type Required Description

restore_snapshot

boolean; default: false

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"