Skip to main content
POST
Restore a stack from a restore point

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

cluster_id
string<uuid>
required

The imported cluster.

stack_name
string
required

The stack's name on the cluster.

restore_point_id
string<uuid>
required

The restore point.

Body

application/json
confirm
string
required

The stack's name.

mode
enum<string>

Optional; any other value is refused.

Available options:
in_place
force
boolean
default:false

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

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.