Skip to content
LabelyardLabelyardLabelyard

Cancel all queued jobs for a printer

POST
/api/v1/printers/{printer_id}/queue/clear
curl --request POST \
  --url https://example.com/api/v1/printers/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/queue/clear \
  --header 'X-Label-Hub-Key: <X-Label-Hub-Key>'

Bulk-cancels every job in queued state for this printer, including jobs that are waiting while the printer is paused; none of them is sent to the printer. Jobs in printing state are intentionally not cancelled — a mid-print abort is unsafe over TCP/9100 because the raster data is already on the wire; a page job the IPP printer already holds is left to finish as well (cancel it with POST /api/v1/jobs/{id}/cancel). An API key without admin scope cancels only the queued jobs it submitted; the jobs of other keys and of browser or SSO users stay queued. Returns 204 even when there are no queued jobs.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
printer_id
required
Printer Id
string format: uuid

Responses

Section titled “Responses”

204

Section titled “204”

Successful Response

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}