Skip to main content
GET
Get account data-retention policy

Authorizations

Authorization
string
header
required

Boat bearer token in the form boat_.... Service API keys authenticate sandbox operations.

Response

Current retention policy.

ok
boolean
required
Example:

true

type
enum<string>
required

Stable success envelope discriminator added by v1.

Available options:
data_retention.info,
data_retention.updated
enabled
boolean
required
enabledAt
string<date-time> | null
required
queuedSandboxes
integer

Archived Sandboxes newly queued for deletion by this policy update.

Required range: x >= 0
acceptedDeletionOperationsIrreversible
boolean

Always true on updates. Disabling the policy does not cancel accepted deletion operations.

snapshotsOff
boolean

When true, every new sandbox of this account is created with snapshots off.

snapshotsOffAt
string<date-time> | null