PilotFoxDocs

List backup runs

GET
/api/v1/admin/backups/runs

Backups, drills and restores, newest first, a page at a time (meta.nextCursor).

Requires a signed-in system administrator (session cookie). API keys and share links: 401; other signed-in users: 403.

Authorization

session
cookie__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).

Query Parameters

cursor?string
Lengthlength <= 2200
limit?integer
Range1 <= value <= 200
Default50

Response Body

OK

application/json
  1. response
data*array<>
meta*
Example Request
curl -X GET 'https://pilotfox.app/api/v1/admin/backups/runs'
Example Response200
{  "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"      }    }  ],  "meta": {    "nextCursor": "string"  }}