Summarize backups

GET

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

GET

/api/public/v1/site-backups/summary

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

200200 - Site backups summary

{
  "data": [
    {
      "attributes": {
        "last_backup": {
          "created_at": "2026-09-18T03:00:00.000000Z",
          "id": 9001,
          "phase": "done",
          "status": "done"
        },
        "last_done_at": "2026-09-18T03:05:00.000000Z",
        "site": {
          "id": 12,
          "name": "Shop"
        },
        "storage_used": 314572800,
        "total_count": 6
      },
      "id": "12",
      "type": "site-backup-summaries"
    },
    {
      "attributes": {
        "last_backup": null,
        "last_done_at": null,
        "site": {
          "id": 13,
          "name": "Blog"
        },
        "storage_used": 0,
        "total_count": 0
      },
      "id": "13",
      "type": "site-backup-summaries"
    }
  ],
  "jsonapi": {
    "version": "1.1"
  },
  "links": {
    "first": "{{base_url}}/api/public/v1/site-backups/summary?page%5Bnumber%5D=1",
    "last": "{{base_url}}/api/public/v1/site-backups/summary?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/summary?page%5Bnumber%5D=1"
      },
      {
        "active": false,
        "label": "Next &raquo;",
        "url": null
      }
    ],
    "path": "{{base_url}}/api/public/v1/site-backups/summary",
    "per_page": 15,
    "to": 2,
    "total": 2
  }
}

Returns one row per website: its newest backup, when it last had a usable backup, how much storage its backups use and how many backups it has. Use it to answer “which websites have no recent backup?” in one call. The backups behind a row are listed by “List backups” with filter[site][].

The rows are websites, so the website filters of “List websites” apply and the rows come in the websites’ default order. Only filter and page are accepted: sort, include and fields answer 422.

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[id][]stringOptional

Exact website ids. Repeat the parameter for several: any of them matches.

filter[team][]stringOptional

Team ids. Repeat the parameter for several: any of them matches.

filter[tags][]stringOptional

Tag ids. Repeat the parameter for several: any of them matches.

filter[connected]stringOptional

1 returns only connected websites; 0 only disconnected ones.

filter[s]stringOptional

Free-text search over the website name or address.

filter[core_version][]stringOptional

Exact WordPress versions, for example 6.8.1. Repeat the parameter for several: any of them matches.

filter[engine_version][]stringOptional

Exact PHP versions, for example 8.2.27. Repeat the parameter for several: any of them matches.

filter[alerts][]stringOptional

Notification configuration ids: only the websites that use any of them.

page[number]stringOptional

Page number, starting at 1. Default 1.

page[size]stringOptional

Items per page, 1 to 50. Default 15.

filter[patchstack]stringOptional

1 returns only the websites with Patch & Protect protection; 0 only the ones without.

Response

200 - Site backups summary

datalist of objectsOptional

jsonapiobjectOptional

linksobjectOptional

metaobjectOptional