Files
dashback/docs/api/routes/backup/run.md
2026-10-14 00:21:31 +02:00

1.2 KiB

POST /backup/run

Protected. Requires a valid session cookie (credentials: 'include').

Trigger manual backup

Immediately triggers an on-demand backup snapshot of VFS, storage, and SQLite database.

Response 200

Backup triggered successfully

{
  "success": true,
  "id": "…",
  "timestamp": "2026-08-10T00:00:00.000Z",
  "promotedDaily": true,
  "promotedMonthly": true,
  "totalSizeBytes": 1,
  "pruneResult": {
    "hourlyPruned": 1,
    "dailyPruned": 1
  },
  "manifest": {
    "id": "…",
    "timestamp": "2026-08-10T00:00:00.000Z",
    "dateKey": "…",
    "monthKey": "…",
    "dbProvider": "…",
    "manual": true,
    "files": {
      "vfs": {
        "name": "…",
        "sizeBytes": 1,
        "sourceExists": true
      },
      "storage": {
        "name": "…",
        "sizeBytes": 1,
        "sourceExists": true
      },
      "database": {
        "name": "…",
        "sizeBytes": 1,
        "backedUp": true,
        "reason": "…"
      }
    },
    "totalSizeBytes": 1,
    "durationMs": 1
  }
}

Errors

Status Description
500 Backup execution failure — {"error":"…"}

Generated from @openapi JSDoc. Do not edit by hand — run npm run docs:api.