Skip to main content
POST
Restore an application deployment from a restore point (browser session)

Authorizations

ankra_session
string
cookie
required

Browser session. Mutations also require X-Ankra-CSRF.

Path Parameters

application_id
string
required
deployment_id
string<uuid>
required

The deployment cluster id.

restore_point_id
string<uuid>
required

Body

application/json

Confirms an in-place restore of one application deployment. The cluster and the stack are never sent: they are resolved from the deployment on the server.

confirm
string
required

The deployment's stack name, as the restore plan returns it in stack_name.

force
boolean
default:false

Proceed although the stack's data no longer matches the restore point. It overrides drift and no other refusal.

mode
enum<string>

Optional. Any other value is refused rather than read as in_place.

Available options:
in_place

Response

The restore run was opened.

restore_point_id
string<uuid>
required
run_id
string<uuid>
required

The restore run to follow.

mode
enum<string>
required
Available options:
in_place
sequence
string[]
required

What the restore does, in order. It opens with the safety restore point when one is taken, naming its id.

warnings
string[]
required
restore_point
object
required

The restore point being restored, without its manifest.