Skip to main content
GET
Get a cluster's backups overview

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.

Query Parameters

limit
integer
default:25

Stacks per page.

Required range: 1 <= x <= 100
cursor
string

The next_cursor of the previous page.

protection_state
enum<string>[]

Only stacks in these states; repeat the parameter for several.

Available options:
protected,
unprotected,
unknown

Response

One page of the tab.

One page of a cluster's Backups tab: rollup, data plane state and stacks.

cluster_id
string<uuid>
required
backup_stack_state
enum<string>
required

The state of the ankra-backup data plane on the cluster.

Available options:
absent,
installing,
ready,
degraded,
unknown
rollup
object
required

Counts over the whole cluster, not the page.

stacks
object[]
required
next_cursor
string | null
required

Pass back as cursor for the next page; null on the last page.

backup_stack_issue
string

Why the data plane keeps failing to install, or which workload is not confirmed running.