Retrieve a backup

GET

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

GET

/api/public/v1/site-backups/:siteBackup

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

200200 - Site backup

{
  "data": {
    "attributes": {
      "attempts": 0,
      "backup_type": "full",
      "comment": "Before the redesign",
      "content": {
        "excluded": [],
        "included": [
          "database",
          "core",
          "plugins",
          "themes",
          "mu_plugins",
          "content",
          "uploads"
        ]
      },
      "created_at": "2026-09-18T03:00:00.000000Z",
      "has_restoration_in_progress": false,
      "is_favorite": false,
      "method": "manual",
      "phase": "done",
      "restoration_allowed": true,
      "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"
  },
  "jsonapi": {
    "version": "1.1"
  }
}

Returns one backup, with more detail than the list: the areas it includes and the exclusions applied, whether the website could take a restoration from it (restorations are started from the dashboard) and whether one is already in progress. These detail attributes answer by default unless fields[site-backups] narrows them.

include=items adds the parts of the backup one by one (database, core, plugins, themes, mu_plugins, content and uploads), each with its own status, phase and size, to explain a failure part by part.

Authentication

AuthorizationBearer

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

Path parameters

siteBackupstringRequired

Query parameters

includestringOptional

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

fields[site-backups]stringOptional

Sparse fieldset: only the attributes named here are answered. Omit it to get every attribute plus the detail ones (content, restoration_allowed, has_restoration_in_progress).

Response

200 - Site backup

dataobjectOptional

jsonapiobjectOptional