Skip to main content
POST
Protect a stack

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
vault_id
string

The vault restore points go to; defaults to the organisation's only ready vault.

schedule
string

An alias such as hourly or daily, or a cron expression.

retention
object

How many restore points each tier keeps.

selection
object
backup_now
boolean

Also take a restore point straight away.

Response

The stack's protection.

The stack's backup policy after a protect or an unprotect.

stack_name
string
required
policy
object
required
backup_stack
enum<string>
required

Whether the data plane that takes captures is installed on the cluster.

Available options:
ready,
installing,
blocked
warnings
string[]
required
restore_point_id
string<uuid> | null
required
run_id
string<uuid> | null
required
commit_sha
string | null
required
commit_url
string | null
required
restore_point
object

A restore point without its manifest, as listings carry it.

git_push_message
string