Skip to main content

Pause Class

POST 
/api/v2/queue-admin/paused-classes

Add an identifier to the pause registry.

Supported identifier shapes:

  • class:<FQCN> — pause all jobs of this class globally.
  • tag:tenant:<id> — pause every job tagged for a tenant (regardless of class).
  • tag:tenant:<id>+class:<FQCN> — pause one class for one tenant.

The row is written to the queue_admin_paused_classes table AND mirrored into a Redis set so workers don't take a DB hit on every job pop. A scheduled reconciliation task expires entries past their paused_until and resyncs Redis once per minute.

Fields:

  • identifier (required, max 512 chars, regex ^(class:|tag:tenant:)) — see shapes above.
  • reason (nullable string, max 512) — free text shown in the UI.
  • paused_until (nullable date/iso8601) — auto-expiry timestamp; omit for indefinite.

Authentication: Requires Bearer token.

Request​

Responses​

Successful response