Cancel Jobs By Tag V1
Cancel every live job that matches a tag filter. AND-match: a job must carry every supplied tag to be cancelled…
POST
Cancel every live job that matches a tag filter.
AND-match: a job must carry every supplied tag to be cancelled. Only
queued / running / awaiting_approval jobs are affected — terminal
jobs are excluded by the SQL filter, regardless of their tags.
Default
dry_run=true so callers always confirm the count before
issuing a destructive op. Hard cap of 200 cancellations per call to
keep the operation bounded; narrow the filter or call repeatedly if
you legitimately need more.
Request body
CancelByTagRequest
string[]
required
Tag values to match — AND-semantics, same as
GET /jobs?tag=. Up to 10 tags per request.string,null
Optional reason stamped on every cancelled job.
boolean
When true (default), counts what would be cancelled without issuing any cancellations. Always start here; flip to false once the count looks right.
Response
CancelByTagResponse
boolean
required
integer
required
integer
required
string[]
required
IDs of every live job that matched the tag filter, regardless of dry_run. Capped at 200 to avoid huge response bodies; if you hit the cap, narrow your tag filter.