Start a backup or drill
POST
Queues a backup, or a drill: a backup restored into a scratch copy whose row counts are compared with the live data. 409 while another run is queued or running, or while the BACKUP_* settings are invalid; 503 when R2 is not configured.
Requires a signed-in system administrator (session cookie). API keys and share links: 401; other signed-in users: 403.
sessioncookie
__Secure-pilotfox.session_token<token>The web app's sign-in session, acting with the user's role; named pilotfox.session_token on an instance whose PUBLIC_URL is plain http. Under /api/v1, a POST, PUT, PATCH or DELETE carrying a cookie must come from the instance's own origin (Origin: PUBLIC_URL or a DASHBOARD_ORIGINS entry; else 403), and a body it carries must be JSON or multipart (else 415).
application/json- body
kind*stringValue in
"backup""drill"Accepted
application/json- response
data*curl -X POST 'https://pilotfox.app/api/v1/admin/backups/runs' \ -H 'Content-Type: application/json' \ -d '{ "kind": "backup"}'Example Response202
{ "data": { "id": "string", "kind": "backup", "trigger": "manual", "status": "queued", "name": "string", "parentRunId": "string", "scheduledFor": "string", "queuedAt": "string", "startedAt": "string", "finishedAt": "string", "postgres": { "key": "string", "bytes": 0 }, "clickhouse": { "prefix": "string", "bytes": 0 }, "error": "string", "details": { "retention": "applied", "drill": { "postgres": [ { "table": "string", "live": 0, "restored": 0 } ], "clickhouse": [ { "table": "string", "before": 0, "restored": 0, "after": 0 } ], "problems": [ "string" ] }, "safetyBackup": "string", "preRestoreDatabase": "string", "pgMigrationsApplied": 0, "chMigrationsApplied": [ "string" ], "pgCommitted": true }, "triggeredBy": { "id": "string", "email": "string" } }}