Snapshots

A base's snapshots, newest first, and the workspace's retention (creators and up)

GET /api/bases/{baseId}/snapshots

Access: base:snapshot on the base (see ACTIONS for the minimum role); signed-in session only (no personal access tokens).

Parameters

Responses

• 200 Success
  • snapshots array of object required
    • id string (uuid) required
    • baseId string (uuid) required
    • baseName string required
    • kind "manual" | "auto" required
    • size integer required
    • tables integer required
    • records integer required
    • createdBy string (uuid) | null required
    • createdAt string (date-time) required
    • expiresAt string (date-time) required
  • retentionDays integer required
• 401 Not signed in
• 403 Signed in, but the role is too low
• 404 No such resource, or no access to it
• 429 Too many requests: a rate limit was reached (see Retry-After)

Take a snapshot of a base now (schema, records, links, attachment references)

POST /api/bases/{baseId}/snapshots

Access: base:snapshot on the base (see ACTIONS for the minimum role); signed-in session only (no personal access tokens).

Parameters

Responses

• 201 Success
  • id string (uuid) required
  • baseId string (uuid) required
  • baseName string required
  • kind "manual" | "auto" required
  • size integer required
  • tables integer required
  • records integer required
  • createdBy string (uuid) | null required
  • createdAt string (date-time) required
  • expiresAt string (date-time) required
• 401 Not signed in
• 403 Signed in, but the role is too low
• 404 No such resource, or no access to it
• 429 Too many requests: a rate limit was reached (see Retry-After)

Restore a snapshot to a new base of the same workspace (never in place), in the background

POST /api/bases/{baseId}/snapshots/{snapshotId}/restore

Access: base:snapshot on the base (see ACTIONS for the minimum role); signed-in session only (no personal access tokens).

Parameters

Request body

• name string

Responses

• 201 Success
  • id string (uuid) required
  • snapshotId string (uuid) required
  • status "running" | "done" | "failed" required
  • base object | null required
    • id string (uuid) required
    • workspaceId string (uuid) required
    • name string required
    • description string | null required
    • icon string | null required
    • color string | null required
    • role "owner" | "creator" | "editor" | "commenter" | "read_only" required
    • createdAt string (date-time) required
    • updatedAt string (date-time) required
  • error string | null required
  • createdAt string required
  • finishedAt string | null required
• 401 Not signed in
• 403 Signed in, but the role is too low
• 404 No such resource, or no access to it
• 422 The request failed validation
• 429 Too many requests: a rate limit was reached (see Retry-After)

A snapshot restore's progress (only who started it)

GET /api/bases/{baseId}/snapshot-restores/{restoreId}

Access: base:snapshot on the base (see ACTIONS for the minimum role); signed-in session only (no personal access tokens).

Parameters

Responses

• 200 Success
  • id string (uuid) required
  • snapshotId string (uuid) required
  • status "running" | "done" | "failed" required
  • base object | null required
    • id string (uuid) required
    • workspaceId string (uuid) required
    • name string required
    • description string | null required
    • icon string | null required
    • color string | null required
    • role "owner" | "creator" | "editor" | "commenter" | "read_only" required
    • createdAt string (date-time) required
    • updatedAt string (date-time) required
  • error string | null required
  • createdAt string required
  • finishedAt string | null required
• 401 Not signed in
• 403 Signed in, but the role is too low
• 404 No such resource, or no access to it
• 429 Too many requests: a rate limit was reached (see Retry-After)

Delete a snapshot

DELETE /api/bases/{baseId}/snapshots/{snapshotId}

Access: base:snapshot on the base (see ACTIONS for the minimum role); signed-in session only (no personal access tokens).

Parameters

Responses

• 204 Success, no content
• 401 Not signed in
• 403 Signed in, but the role is too low
• 404 No such resource, or no access to it
• 429 Too many requests: a rate limit was reached (see Retry-After)

Change how long the workspace's base snapshots are kept (owners)

PATCH /api/workspaces/{workspaceId}/snapshot-settings

Access: workspace:update on the workspace (see ACTIONS for the minimum role); signed-in session only (no personal access tokens).

Parameters

Request body

• retentionDays integer required

Responses

• 200 Success
  • retentionDays integer required
• 401 Not signed in
• 403 Signed in, but the role is too low
• 404 No such resource, or no access to it
• 422 The request failed validation
• 429 Too many requests: a rate limit was reached (see Retry-After)