Show site backup | Modular DS | API documentation

One backup by its exact id, as a JSON:API document of type site-backups: everything the listing shows plus the detail fields, answered by default unless fields[site-backups] narrows them: content (the areas included and the exclusions), restoration_allowed (whether the website could take a restoration from it - a restoration is started from the dashboard only) and has_restoration_in_progress.

include=items adds the parts of the copy as site-backup-items resources (type: database, core, plugins, themes, mu_plugins, content, uploads; status, phase, size, total_items), one row per part, to explain a failure part by part.

Path variable siteBackup is the exact backup id from the listing. A backup of another organization answers 404. A read-only token is enough. The MCP twin is the site-backups-show tool.

One backup by its exact id, as a JSON:API document of type `site-backups`: everything the listing shows plus the detail fields, answered by default unless `fields[site-backups]` narrows them: `content` (the areas included and the exclusions), `restoration_allowed` (whether the website could take a restoration from it - a restoration is started from the dashboard only) and `has_restoration_in_progress`. `include=items` adds the parts of the copy as `site-backup-items` resources (`type`: database, core, plugins, themes, mu_plugins, content, uploads; `status`, `phase`, `size`, `total_items`), one row per part, to explain a failure part by part. Path variable `siteBackup` is the exact backup id from the listing. A backup of another organization answers 404. A read-only token is enough. The MCP twin is the `site-backups-show` tool.

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

items - the parts of the copy; site - the website

fields[site-backups]stringOptional

Sparse fieldset; omit it to get every attribute plus the three detail fields

Response

Path variable siteBackup is the exact backup id from the listing. A backup of another organization answers 404. A read-only token is enough. The MCP twin is the site-backups-show tool.