List restorations

GET

https://api.modulards.com/api/public/v1/site-restorations

GET

/api/public/v1/site-restorations

curl https://api.modulards.com/api/public/v1/site-restorations \
     -H "Authorization: Bearer <token>"

200200 - Site restorations, one finished and one in progress

{
  "data": [
    {
      "attributes": {
        "created_at": "2026-09-20T09:00:00.000000Z",
        "created_by": 34,
        "error_message": null,
        "expired_at": "2026-09-20T11:00:00.000000Z",
        "phase": "in_progress",
        "site_backup_id": 9002,
        "status": "move_progress",
        "type": "migration_new_domain",
        "updated_at": "2026-09-20T09:05:00.000000Z",
        "uri": "https://staging.acme.com"
      },
      "id": "502",
      "links": {
        "self": "{{base_url}}/api/public/v1/site-restorations/502"
      },
      "type": "site-restorations"
    },
    {
      "attributes": {
        "created_at": "2026-09-14T10:00:00.000000Z",
        "created_by": 34,
        "error_message": null,
        "expired_at": "2026-09-14T12:00:00.000000Z",
        "phase": "done",
        "site_backup_id": 9001,
        "status": "finished",
        "type": "restoration",
        "updated_at": "2026-09-14T10:18:00.000000Z",
        "uri": null
      },
      "id": "501",
      "links": {
        "self": "{{base_url}}/api/public/v1/site-restorations/501"
      },
      "type": "site-restorations"
    }
  ],
  "jsonapi": {
    "version": "1.1"
  },
  "links": {
    "first": "{{base_url}}/api/public/v1/site-restorations?page%5Bnumber%5D=1",
    "last": "{{base_url}}/api/public/v1/site-restorations?page%5Bnumber%5D=1",
    "next": null,
    "prev": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "active": false,
        "label": "&laquo; Previous",
        "url": null
      },
      {
        "active": true,
        "label": "1",
        "url": "{{base_url}}/api/public/v1/site-restorations?page%5Bnumber%5D=1"
      },
      {
        "active": false,
        "label": "Next &raquo;",
        "url": null
      }
    ],
    "path": "{{base_url}}/api/public/v1/site-restorations",
    "per_page": 15,
    "to": 2,
    "total": 2
  }
}

Lists the restorations run from your backups, newest first. Use it to follow how a restoration is going or why it failed: phase is in_progress, done, failed or excluded, status is the raw step (download, unzip, move, database and so on), and a restoration that never finished before its expired_at reads phase: failed. type tells a restoration in place from the migration variants (migration_same_domain, migration_new_domain, migration_existing_site, migration_staging).

Restorations are read only by design: a restoration touches the customer’s files and database, so it is started from the dashboard. Nothing in this API starts, cancels or downloads one.

Your role must be allowed to read restorations; without it the request answers 404.

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. Repeat the parameter for several: any of them matches.

filter[backup][]stringOptional

Exact backup ids: the restorations run from those backups. Repeat the parameter for several.

filter[id][]stringOptional

Exact restoration ids. Repeat the parameter for several.

filter[phase][]stringOptional

in_progress, done, failed or excluded. Repeat the parameter for several.

filter[status][]stringOptional

Raw processing steps, for when phase is not enough. Repeat the parameter for several.

filter[type][]stringOptional

restoration, migration_same_domain, migration_new_domain, migration_existing_site or migration_staging. Repeat the parameter for several.

includestringOptional

Relations to add to the answer, comma separated: site (the website) and backup (the backup the restoration came from).

sortstringOptional

created_at or updated_at; prefix with - for descending. Default: -created_at (newest first).

page[number]stringOptional

Page number, starting at 1. Default 1.

page[size]stringOptional

Items per page, 1 to 50. Default 15.

Response

200 - Site restorations, one finished and one in progress

datalist of objectsOptional

jsonapiobjectOptional

linksobjectOptional

metaobjectOptional