cdnca

API reference

/v1/admin/system-backup-runs

1 operations

← All groups · First call? Read the tutorial: auth, permissions, requests and responses, common failures

MethodPathSummaryAuth
GET/v1/admin/system-backup-runsRead persisted control-plane backup run historySession

Contract file：api/control-backup-history.openapi.yaml

Operation details

GET /v1/admin/system-backup-runs

Read persisted control-plane backup run history

operationId
listSystemBackupRuns
Auth
  • Session: the Bearer session of a signed-in control plane user, used by the customer in their own control plane; a plugin must never ask for it.
Required permissions

The contract has no separate permission annotation; see the description below and the 403 response.

Description (from the contract)

Reads only signed start and terminal facts persisted by the controlled backup runner. A missing terminal or an unverifiable fact is returned as an unknown outcome and is never inferred from plans, approvals, or audit events. With no backup runner bound it answers an empty page with unconfigured=true; a partial or invalid binding is unavailable.

Parameters

listSystemBackupRuns Parameters
NameInTypeRequiredDescription
backup_idquerystringNo—
statequerystring: succeeded / failed / unknownNo—
fromquerystring(date-time)No—
toquerystring(date-time)No—
limitqueryinteger: 10 / 30 / 100 / 300No—
cursorquerystringNoSigned continuation bound to the backup ID, state, and effective time range; omitted times retain the first page range.

Responses

listSystemBackupRuns Responses
StatusDescription
200Persisted backup run facts

Fields：schema: string items: array<BackupRunHistoryRecord> total_count: integer next_cursor?: string snapshot_at: string(date-time) unconfigured?: boolean

400Invalid query or cursor
401Authentication required
403Platform administrator permission required
503Protected backup history capability unavailable

What to do on failure

  • 400 Fix the parameters or body per the field list; do not retry unchanged.
  • 401 Check the credential format and whether it expired or was rotated.
  • 403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.
  • 503 A dependency is unavailable: retry later with the original Idempotency-Key.

↑ Back to list