OpenAPI JSON

Restore a site

A restore starts a background task. Choose the snapshot first, make the scope explicit, then monitor the returned task.

Prerequisites

You need a site ID and a completed snapshot ID. Use List site snapshots and select a snapshot with status: succeeded.

Start a full restore

Start a site backup restore restores files and database tables when both scope flags are true:

curl --request POST \
  --url https://api.blogvault.net/api/v6/sites/SITE_ID/backups/SNAPSHOT_ID/restore \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "restore": {
      "scope": {
        "include_files": true,
        "include_database": true
      }
    }
  }'

The response returns the task created for the restore. Use Show a task until the task reaches a terminal state.

Selective restore

To restore only part of the snapshot, keep the relevant scope flag enabled and provide paths, tables, or—on multisite—subsite_ids. The endpoint documentation defines the precedence rules when explicit paths or tables overlap with subsite selections.

Safety checklist

  • Confirm the site and snapshot IDs before sending the request.
  • Tell the operator that the restore changes live site content.
  • Record the task ID and request details.
  • Treat 409 as a state conflict; inspect existing work before retrying.
  • Treat 422 as a business-rule failure and read error.details.