BullMQ Proxy
  • What is BullMQ Proxy
  • Getting started
    • Architecture overview
    • Using Dragonfly
  • HTTP API
    • Authentication
    • Queues
      • Adding jobs
        • Retries
        • Delayed jobs
        • Prioritized
        • Repeatable
        • LIFO
        • Custom Job IDs
      • Getting jobs
      • Queue's actions
      • Reference
    • Workers
      • Endpoints
      • Adding workers
        • Concurrency
        • Rate-Limit
        • Removing finished jobs
        • Stalled jobs
        • Timeouts
      • Removing workers
      • Getting workers
      • Reference
    • Jobs
      • Jobs' actions
        • Update job progress
        • Add job logs
      • Reference
    • Configuration
    • Debugging
Powered by GitBook
On this page
  1. HTTP API
  2. Queues

Getting jobs

The proxy also provides convenient endpoints that allow getting jobs, either as a page of jobs based on some filtering options or a given job based on its job ID.

A page of jobs follows this interface:

interface JobsPage {
  start: number;
  length: number;
  count: {
    waiting: number;
    active: number;
    completed: number;
    failed: number;
  },
  jobs: JsonJob[];
}

Access the jobs endpoint providing a start and a length so that you can fetch a particula page of jobs.

curl --location 'http://mydomain.dev/queues/my-queue/jobs?\
statuses=completed,failed&start=10&length=20' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer my-secret-token'

If you are instead interested in getting one particular job based on its id, just use this endpoint instead:

curl --location 'http://mydomain.dev/queues/my-queue/jobs/my-job-id
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer my-secret-token'
PreviousCustom Job IDsNextQueue's actions

Last updated 1 year ago

And if the job exists you will get a object.

JobJson