PilotFoxDocs

List job queues

GET
/api/v1/admin/jobs

Each background job queue with its queued, active, failed, deferred and total counts, and the cron schedules.

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/jobs'
Example Response200
{  "data": {    "queues": [      {        "name": "string",        "policy": "string",        "queuedCount": 0,        "activeCount": 0,        "failedCount": 0,        "deferredCount": 0,        "totalCount": 0      }    ],    "schedules": [      {        "name": "string",        "cron": "string",        "timezone": "string"      }    ]  }}