Skip to main content
PUT
Set state snapshot retention

Authorizations

Authorization
string
header
required

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

Headers

x-ankra-organisation-id
string

PAT organisation override.

Path Parameters

cluster_id
string<uuid>
required

Body

application/json

Sets the retention window of one cluster's scheduled etcd backups.

retention_days
integer
required

How many UTC days the newest scheduled etcd backup of each day is kept for. Must be a real integer.

Required range: 1 <= x <= 90

Response

Successful response

A cluster's retention window for its scheduled etcd backups.

cluster_id
string<uuid>
required
retention_days
integer
required

The window in effect: the stored value, or the default when none is stored.

is_default
boolean
required

True when no window was set for the cluster and the default applies.

default_retention_days
integer
required

The window of a cluster nobody set one for.

minimum_retention_days
integer
required

The shortest window that may be set.

maximum_retention_days
integer
required

The longest window that may be set.

keep_latest
integer
required

How many of the newest scheduled backups are kept whatever their day, on top of the daily ones.