List, download or diff project backups
curl --request GET \
--url https://studio.weaverse.io/api/v1/content/projects/{projectId}/backups \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://studio.weaverse.io/api/v1/content/projects/{projectId}/backups', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://studio.weaverse.io/api/v1/content/projects/{projectId}/backups"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"object": "list",
"data": [
{
"id": "clz9a1b2c0010mnbv5cxz4lkj",
"byteSize": 48213,
"trigger": "MANUAL",
"createdAt": "2026-10-18T09:12:44.000Z"
},
{
"id": "clz9a0f8e0009hgfd3sap2oiu",
"byteSize": 47980,
"trigger": "SCHEDULED",
"createdAt": "2026-10-17T21:00:03.000Z"
}
]
}{
"object": "error",
"code": "UNAUTHORIZED",
"message": "<string>",
"status": 123,
"details": "<unknown>"
}{
"object": "error",
"code": "UNAUTHORIZED",
"message": "<string>",
"status": 123,
"details": "<unknown>"
}{
"object": "error",
"code": "UNAUTHORIZED",
"message": "<string>",
"status": 123,
"details": "<unknown>"
}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 }] }.triggeris one ofSCHEDULED,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 filePOST /backup-restoresaccepts.?diff=<id>: compares that backup with the live project and returns{ object: "backup_diff", backupId, diff }.diffhasadded/removed/changed/unchangedcounts forpages,items,translations,globalSectionsandlanguages(with namedchangeswhere a label exists, capped),theme.changed, andhasChanges.
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
List, download or diff project backups
curl --request GET \
--url https://studio.weaverse.io/api/v1/content/projects/{projectId}/backups \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://studio.weaverse.io/api/v1/content/projects/{projectId}/backups', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://studio.weaverse.io/api/v1/content/projects/{projectId}/backups"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"object": "list",
"data": [
{
"id": "clz9a1b2c0010mnbv5cxz4lkj",
"byteSize": 48213,
"trigger": "MANUAL",
"createdAt": "2026-10-18T09:12:44.000Z"
},
{
"id": "clz9a0f8e0009hgfd3sap2oiu",
"byteSize": 47980,
"trigger": "SCHEDULED",
"createdAt": "2026-10-17T21:00:03.000Z"
}
]
}{
"object": "error",
"code": "UNAUTHORIZED",
"message": "<string>",
"status": 123,
"details": "<unknown>"
}{
"object": "error",
"code": "UNAUTHORIZED",
"message": "<string>",
"status": 123,
"details": "<unknown>"
}{
"object": "error",
"code": "UNAUTHORIZED",
"message": "<string>",
"status": 123,
"details": "<unknown>"
}Authorizations
Bearer token: a shop API key (WEAVERSE_API_KEY), a scoped API key or a delegated MCP OAuth token; translation-unit routes also accept a project-bound translation agent token. Each operation lists the scope it requires; the scope table is in the API description.
Path Parameters
Response
Backup list, or the diff for ?diff=. ?backupId= downloads the stored backup as a brotli-compressed JSON attachment (application/x-brotli).
The response is of type object.
Was this page helpful?