Backups and portability

List, download or diff project backups

Read-only access to the project's point-in-time backups. One endpoint, three modes:

  • No query: lists backups, newest first, as { object: "list", data: [{ id, byteSize, trigger, createdAt }] }. trigger is one of SCHEDULED, PRE_DELETE, PRE_RESET, PRE_PUBLISH, MANUAL.
  • ?backupId=<id>: downloads the stored backup as a brotli-compressed file (application/x-brotli, attachment). This is the file POST /backup-restores accepts.
  • ?diff=<id>: compares that backup with the live project and returns { object: "backup_diff", backupId, diff }. diff has added/removed/changed/unchanged counts for pages, items, translations, globalSections and languages (with named changes where a label exists, capped), theme.changed, and hasChanges.

A backup id is resolved through this project and the caller's shop before any storage read; an unknown or foreign id returns 404.

Required scope: project:manage

get/projects/{projectId}/backups

Request

  • Base URL
    https://studio.weaverse.io/api/v1/content
  • Auth
    HTTP bearer

Response

Backup list, or the diff for ?diff=. ?backupId= downloads the stored backup as a brotli-compressed JSON attachment (application/x-brotli).

object required

Changes

No recorded changes to this operation across all 1 revision of this API.