List site restorations | Modular DS

Lists the restorations run from the token’s backups, newest first, as a JSON:API collection of type site-restorations: type (restoration, migration_same_domain, migration_new_domain, migration_existing_site, migration_staging), status (the raw step: download, unzip, move, database…), phase (in_progress, done, failed or excluded), error_message, uri, site_backup_id, created_by, created_at, updated_at, expired_at. A restoration that never finished before expired_at reads phase: failed.

Read only by decision: a restoration touches the customer’s files and database, so it is started from the dashboard only. Nothing on this surface starts, cancels or downloads one.

include=site,backup adds the website and the backup the restoration came from. Restorations of other organizations - and members without the restorations read permission - answer 404. A read-only token is enough. The MCP twin of this endpoint is the site-restorations-index tool.

Lists the restorations run from the token's backups, newest first, as a JSON:API collection of type `site-restorations`: `type` (`restoration`, `migration_same_domain`, `migration_new_domain`, `migration_existing_site`, `migration_staging`), `status` (the raw step: download, unzip, move, database...), `phase` (`in_progress`, `done`, `failed` or `excluded`), `error_message`, `uri`, `site_backup_id`, `created_by`, `created_at`, `updated_at`, `expired_at`. A restoration that never finished before `expired_at` reads `phase: failed`. Read only by decision: a restoration touches the customer's files and database, so it is started from the dashboard only. Nothing on this surface starts, cancels or downloads one. `include=site,backup` adds the website and the backup the restoration came from. Restorations of other organizations - and members without the restorations read permission - answer 404. A read-only token is enough. The MCP twin of this endpoint is the `site-restorations-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[backup][]stringOptional

Exact backup ids: the restorations run from those copies (repeatable)

filter[id][]stringOptional

Exact restoration ids (repeatable)

filter[phase][]stringOptional

in_progress | done | failed | excluded (repeatable)

filter[status][]stringOptional

Raw pipeline steps (repeatable), when phase is not enough

filter[type][]stringOptional

restoration | migration_same_domain | migration_new_domain | migration_existing_site | migration_staging (repeatable)

includestringOptional

site, backup

sortstringOptional

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

page[number]stringOptional

page[size]stringOptional

Max 50

Response

Read only by decision: a restoration touches the customer’s files and database, so it is started from the dashboard only. Nothing on this surface starts, cancels or downloads one.