Create Workspace Backup Api

POST

/workspace/backup

• Production
• QA

Start a backup of everything this key can read in the custom-object workspace (a restricted archive). Its history (who changed what) is included only for a key holding objects:audit.

Authorizations

• BearerAuth

Parameters

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Responses

202

Successful Response

object

data

required

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

integer

null

null

archive_sha256

Any of:

string

string

null

null

completed_at

Any of:

string

string format: date-time

null

null

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

string

null

null

expires_at

Any of:

string

string format: date-time

null

null

format_version

Any of:

integer

integer

null

null

history

Any of:

string

string

Allowed values: included omitted

null

null

history_reason

Any of:

string

string

Allowed values: audit_permission_required audit_log_switched_off

null

null

id

required

string format: uuid

not_restorable_reason

Any of:

string

string

Allowed values: restricted_backup expired not_completed

null

null

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

string

Allowed values: member api_key

null

null

name

Any of:

string

string

null

null

restorable

Only a complete backup can be restored.

boolean

scope

Any of:

string

string

Allowed values: complete restricted

null

null

started_at

Any of:

string

string format: date-time

null

null

status

required

string

Allowed values: pending running completed failed expired

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

notes

Any of:

Array<string>

Array<string>

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

total_available

Any of:

integer

integer

null

null

total_is_lower_bound

Any of:

boolean

boolean

null

null

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string