PilotFoxDocs

List stored backups

GET
/api/v1/admin/backups/remote

The backups found in R2, and whether each one is complete enough to restore; 503 when R2 is not configured or cannot be read.

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*array<>
Example Request
curl -X GET 'https://pilotfox.app/api/v1/admin/backups/remote'
Example Response200
{  "data": [    {      "name": "string",      "kind": "backup",      "takenAt": "string",      "postgres": {        "key": "string",        "bytes": 0,        "lastModified": "string"      },      "clickhouse": {        "prefix": "string",        "complete": true      },      "restorable": true    }  ]}