Skip to content

List Workspace Backups Api

GET
/workspace/backup

This key’s backups, newest first, and whether backup storage is configured (a backup answers 503 if not).

Authorizations

Parameters

Query Parameters

limit
integer
default: 50 >= 1 <= 200
offset
integer

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
object
backups
required
Array<object>

A workspace backup: complete (made by a workspace administrator: every object, field, grant and report) or restricted (exactly what the requester could read). The archive is deleted 14 days after created_at.

object
archive_bytes
Any of:
integer
archive_sha256
Any of:
string
completed_at
Any of:
string format: date-time
counts

Rows per archive section.

object
key
additional properties
integer
created_at
required
string format: date-time
download_available
boolean
error_code
Any of:
string
expires_at
Any of:
string format: date-time
format_version
Any of:
integer
history
Any of:
string
Allowed values: included omitted
history_reason
Any of:
string
Allowed values: audit_permission_required audit_log_switched_off
id
required
string format: uuid
not_restorable_reason
Any of:
string
Allowed values: restricted_backup expired not_completed
requested_by
required

Who asked. name and kind are shown to a workspace administrator only (anyone else lists only their own jobs and reads is_you); name is the member’s display name, None for an API key or an unknown member.

object
is_you
required
boolean
kind
Any of:
string
Allowed values: member api_key
name
Any of:
string
restorable

Only a complete backup can be restored.

boolean
scope
Any of:
string
Allowed values: complete restricted
started_at
Any of:
string format: date-time
status
required
string
Allowed values: pending running completed failed expired
limit
required
integer
offset
required
integer
storage_configured

False while backup storage is not configured: starting a backup would answer 503.

boolean
default: true
total
required
integer
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string