Jobs
Every 202 lands here. Poll with logAfter and use the returned lastSeq as the next cursor.
Reading needs Read only and changes need Manage, unless an endpoint says otherwise. How to read this page.
GET /api/jobs
Section titled “GET /api/jobs”Jobs, newest first; status, type, category and origin take comma lists.
- Level: Read only
- Input:
?q=&status=&type=&category=&origin=&siteSlug=&serverId=&scheduleId=&batchId=&since=&until=&limit=&offset= - Returns:
{items, total, counts (per status), retentionDays}
GET /api/jobs/types
Section titled “GET /api/jobs/types”Every job type with its name, description, category and time limit.
- Level: Read only
- Returns:
{items: [{type, label, description, category, internal, timeoutMs}]}
GET /api/jobs/:id
Section titled “GET /api/jobs/:id”One job plus the log lines after a cursor.
- Level: Read only
- Input:
?logAfter=<seq> - Returns:
{job, logs[], lastSeq}
POST /api/jobs/:id/cancel
Section titled “POST /api/jobs/:id/cancel”Cancel a queued job, or ask a running one to stop.
- Level: Manage
- Notes: Destructive