Skip to main content
POST
Back up a stack now

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.

Body

application/json

Optional. An empty body captures the stack as its policy describes.

vault_id
string<uuid>

The vault to capture into; defaults to the stack's policy vault.

selection
object

What to capture; omitted takes the stack's policy selection.

note
string

Response

The capture started.

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

The backup run to follow.

restore_point
object
required

A restore point with its manifest. Each manifest asset may carry artifacts, the uploaded files with size_bytes and sha256 as verified at capture; object keys are withheld.

warnings
string[]
required