PilotFoxDocs

Get the backup status

GET
/api/v1/admin/backups

The R2 bucket, the schedule and the next run, the last success and failure, the run in progress, the ClickHouse copies a drill or restore left behind, and the Postgres client's compatibility.

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

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X GET 'https://pilotfox.app/api/v1/admin/backups'
Example Response200
{  "data": {    "r2": {      "bucket": "string",      "endpoint": "string"    },    "retentionDays": 0,    "timeoutSeconds": 0,    "configError": "string",    "schedule": {      "schedule": "off",      "hour": -9007199254740991,      "weekday": -9007199254740991,      "updatedAt": "string",      "updatedBy": {        "id": "string",        "email": "string"      }    },    "nextRunAt": "string",    "lastSuccess": {      "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"      }    },    "lastFailure": {      "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"      }    },    "active": {      "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"      }    },    "leftovers": [      {        "name": "string",        "reason": "string"      }    ],    "postgresClient": {      "version": "string",      "serverMajor": 0,      "compatible": true,      "error": "string"    }  }}