List site backups | Modular DS

Lists the backups of every website the token can reach, newest first, as a JSON:API collection of type site-backups with the usual links / meta pagination. Narrow with filter[site][] (exact website ids) or filter[id][] (the backup ids a create or retry answered) to follow a batch.

Each entry carries site_id, status, phase, attempts, backup_type (full / incremental), method (manual / automatic / force_first), size, is_favorite (master backup, kept out of the retention policy), restored_at, comment, created_at and updated_at.

phase is the state to read: in_progress (still running), done (a usable copy) or failed (the server retries a failed copy on its own up to four times during its first day; attempts counts them). excluded never matches a backup: it is the phase of a part that had nothing to copy - see include=items on the show endpoint. status is the raw pipeline step behind it.

include=site adds the website; the parts of a copy (include=items) and the detail fields belong to the show endpoint.

Websites of other organizations - and members without the backups read permission - answer 404; an unknown filter answers 400 and an invalid value 422. A read-only token is enough. The MCP twin of this endpoint is the site-backups-index tool.

Lists the backups of every website the token can reach, newest first, as a JSON:API collection of type `site-backups` with the usual `links` / `meta` pagination. Narrow with `filter[site][]` (exact website ids) or `filter[id][]` (the backup ids a create or retry answered) to follow a batch. Each entry carries `site_id`, `status`, `phase`, `attempts`, `backup_type` (`full` / `incremental`), `method` (`manual` / `automatic` / `force_first`), `size`, `is_favorite` (master backup, kept out of the retention policy), `restored_at`, `comment`, `created_at` and `updated_at`. `phase` is the state to read: `in_progress` (still running), `done` (a usable copy) or `failed` (the server retries a failed copy on its own up to four times during its first day; `attempts` counts them). `excluded` never matches a backup: it is the phase of a part that had nothing to copy - see `include=items` on the show endpoint. `status` is the raw pipeline step behind it. `include=site` adds the website; the parts of a copy (`include=items`) and the detail fields belong to the show endpoint. Websites of other organizations - and members without the backups read permission - answer 404; an unknown filter answers 400 and an invalid value 422. A read-only token is enough. The MCP twin of this endpoint is the `site-backups-index` tool.

Authentication

AuthorizationBearer

Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.

Query parameters

filter[site][]stringOptional

Exact website ids (repeatable)

filter[id][]stringOptional

Exact backup ids, e.g. the ids a create or retry answered (repeatable)

filter[phase][]stringOptional

in_progress | done | failed | excluded (repeatable). Only done is a usable copy

filter[status][]stringOptional

Raw pipeline steps: done, pending, manifest_in_progress, manifest_upload_pending, manifest_uploading, manifest_done, in_progress, upload_pending, uploading, excluded, failed, failed_in_creation, failed_export_database, failed_export_files, failed_export_manifest, failed_in_processing, failed_uploaded, failed_partial, failed_file_not_found, storage_exceeded (repeatable)

filter[backup_type][]stringOptional

full | incremental - the model’s type column, aliased because type is reserved in JSON:API (repeatable)

filter[method][]stringOptional

manual | automatic | force_first (repeatable)

filter[is_favorite]stringOptional

1|0 - only master backups, or only the rotating ones

includestringOptional

site - the website each backup belongs to

sortstringOptional

created_at, size; prefix with - to invert. Default: -created_at (newest first)

page[number]stringOptional

page[size]stringOptional

Max 50

Response

include=site adds the website; the parts of a copy (include=items) and the detail fields belong to the show endpoint.