List backups

GET

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

GET

/api/public/v1/site-backups

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

200200 - Site backups

{
  "data": [
    {
      "attributes": {
        "attempts": 0,
        "backup_type": "full",
        "comment": null,
        "created_at": "2026-09-18T03:00:00.000000Z",
        "is_favorite": false,
        "method": "manual",
        "phase": "done",
        "restored_at": null,
        "site_id": 12,
        "size": 104857600,
        "status": "done",
        "updated_at": "2026-09-18T03:05:00.000000Z"
      },
      "id": "9001",
      "links": {
        "self": "{{base_url}}/api/public/v1/site-backups/9001"
      },
      "type": "site-backups"
    },
    {
      "attributes": {
        "attempts": 2,
        "backup_type": "full",
        "comment": null,
        "created_at": "2026-09-17T03:00:00.000000Z",
        "is_favorite": false,
        "method": "automatic",
        "phase": "failed",
        "restored_at": null,
        "site_id": 12,
        "size": 0,
        "status": "failed_export_database",
        "updated_at": "2026-09-17T03:10:00.000000Z"
      },
      "id": "9000",
      "links": {
        "self": "{{base_url}}/api/public/v1/site-backups/9000"
      },
      "type": "site-backups"
    }
  ],
  "jsonapi": {
    "version": "1.1"
  },
  "links": {
    "first": "{{base_url}}/api/public/v1/site-backups?page%5Bnumber%5D=1",
    "last": "{{base_url}}/api/public/v1/site-backups?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-backups?page%5Bnumber%5D=1"
      },
      {
        "active": false,
        "label": "Next &raquo;",
        "url": null
      }
    ],
    "path": "{{base_url}}/api/public/v1/site-backups",
    "per_page": 15,
    "to": 2,
    "total": 2
  }
}

Lists the backups of every website your token can reach, newest first. Use filter[site][] for the backups of one or several websites, or filter[id][] with the ids a create or retry returned to follow that batch.

Read phase to know where a backup stands: in_progress (still running), done (a usable copy) or failed. A failed or stalled backup is retried automatically, up to 3 times (4 attempts in all, counted in attempts), within 24 hours of its creation: a rolling 24 hours from its creation time, not the rest of the calendar day. Once a backup has not changed for two hours, the server queues it again; after that it stays failed and attempts reads 4. excluded is the phase of a part that had nothing to copy, so it never matches a whole backup (see include=items on “Retrieve a backup”). status is the raw processing step behind the phase. is_favorite marks a master backup, which is kept out of the retention policy.

Your role must be allowed to read backups; 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[id][]stringOptional

Exact backup ids, for example the ones a create or retry returned. Repeat the parameter for several.

filter[phase][]stringOptional

in_progress, done, failed or excluded. Repeat the parameter for several. Only done is a usable copy.

filter[status][]stringOptional

Raw processing steps, for example done, pending, in_progress, uploading, failed, failed_in_creation, failed_export_database, failed_export_files, storage_exceeded. Repeat the parameter for several. Use filter[phase][] unless you need the exact step.

filter[backup_type][]stringOptional

full or incremental. Repeat the parameter for several. Named backup_type because type is reserved in JSON:API.

filter[method][]stringOptional

How the backup started: manual, automatic for a scheduled one, or force_first for the first automatic backup of a website. Repeat the parameter for several: any of them matches.

filter[is_favorite]stringOptional

1 returns only master backups; 0 returns only the ones that follow the retention policy.

includestringOptional

Relations to add to the answer, comma separated: site (the website each backup belongs to) and items (the parts of each backup).

sortstringOptional

created_at or size (in bytes); 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.

fields[site-backups]stringOptional

Sparse fieldset: only the attributes named here are answered. content, restoration_allowed and has_restoration_in_progress are computed only when named here.

Response

200 - Site backups

datalist of objectsOptional

jsonapiobjectOptional

linksobjectOptional

metaobjectOptional