v36

latestOpenAPI 3.0.3GNU General Public License v3.0raw.githubusercontent.com2026-08-017758212.6 KB
queue

Manage queue operations

Deprecated. Prefer the jobs-namespace cancel endpoints: POST /api/jobs/cancel for cancelling jobs by ID, and POST /api/jobs/{job_id}/cancel for a single job.

Cancel specific jobs by ID (the delete field) or clear all pending jobs in the queue (the clear field). Despite the delete naming, this does not delete anything — listed jobs transition to the cancelled state, and delete cancels both pending and running jobs (not pending-only as previously documented). Job-by-ID cancellation is superseded by POST /api/jobs/cancel; clear has no jobs-namespace replacement yet.

post/api/queue

Request body

clearboolean

If true, clear all pending jobs from the queue

deletestring[]

Array of job IDs to cancel; pending and running jobs transition to cancelled

Response

Success

clearedboolean

Whether the queue was cleared

deletedstring[]

Array of job IDs that were successfully cancelled