Skip to main content
PATCH
Update account data-retention policy

Authorizations

Authorization
string
header
required

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

Body

application/json
enabled
boolean
required
confirmation
string

Required when enabling and must exactly equal delete archived sandbox data.

Allowed value: "delete archived sandbox data"

Response

Updated retention policy. Responses are never cached.

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.