jobs

Job lifecycle management with metrics, history, retries, execution control, cleanup, and test enqueue flows.

Source path: libraries/queue/src/queue-job.controller.ts, libraries/queue/src/job/job.controller.ts

Module file: queue.module.ts

Introduction

The Jobs submodule is the core operational surface of the Queue package. It exposes both administrative listing/metrics endpoints and action endpoints for canceling, requeueing, executing, dead-lettering, or cleaning jobs.

The codebase currently contains both `queue-job.controller.ts` and a legacy `job/job.controller.ts` sharing the `/queue/jobs` namespace. The richer controller is the one documented here, while the legacy controller is best understood as an older compatibility surface over the same domain.

HTTP Endpoints

18 endpoints

List jobs.

Query: page, pageSize, search, queueName, status, type

Return aggregate queue-job metrics.

Return metrics grouped by queue.

Return metrics grouped by job type.

Return historical job view data.

Compare performance by queue configuration.

Get one job.

Params: id (int)

List attempts for one job.

Params: id (int)

List lifecycle events for one job.

Params: id (int)

Create or enqueue a job.

Run cleanup against old jobs.

Update editable job fields.

Params: id (int)

Delete jobs in bulk.

Body

Field	Type	Required	Notes
ids	number[]	yes	—

Cancel a job.

Params: id (int)

Requeue a job.

Params: id (int)

Force immediate execution of a job.

Params: id (int)

Move a job to dead-letter handling.

Params: id (int)

Create test jobs for queue verification.