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
  • Update Job Progress
  • Add Job Logs
  • Get Job Logs
  1. HTTP API
  2. Jobs

Reference

Reference for jobs' actions.

PreviousAdd job logsNextConfiguration

Last updated 1 year ago

Update Job Progress

POST /queues/:queue-name/jobs/:job-id/progress

Updates the progress of a given job. The progress can be a number or any other json serializable object.

Note, the token used as bearer token must be the received on the worker's endpoint specific for a given job.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <job-token>

Body

An integer or any JSON serializable object.

Response

OK
Message with the reason for the invalid request.

Add Job Logs

POST /queues/:queue-name/jobs/:job-id/logs

Add a log to a given job. Any number of logs can be added to a given job.

Note, the token used as bearer token must be the received on the worker's endpoint specific for a given job.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <job-token>

Body

A plain string with the message to add as a log.

Response

OK
Message with the reason for the error

Get Job Logs

GET /queues/:queue-name/jobs/:job-id/logs?start=0&length=10

<Description of the endpoint>

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Query

Name
Type
Description

start

number

First log to return

length

number

Number of logs to return

Response

{
  "count": number,
  "logs": string[],
}
Message with the reason for the error
token
token