Cloady Docs
API ReferenceEndpointsApplications

Read a worker's recent runs and failures

Returns the newest job runs with their state, attempt, run time and error text, the jobs that schedules added within the range, the newest failure of each job type, and up to three failed or dead jobs per queue. Requires the developer role, because error texts can carry job data.

GET
/api/workspaces/{workspaceSlug}/apps/{appSlug}/services/{serviceName}/jobs/details

Authorization

cloady
AuthorizationBearer <token>

Personal API token (cldy_…)

In: header

Path Parameters

workspaceSlug*string
appSlug*string
serviceName*string

Query Parameters

env?string

Value in

  • "production"
  • "preview"
  • "development"
region?string
range?string

How far back to look; the answer has 30 to 96 points across it

Default"1h"

Value in

  • "15m"
  • "1h"
  • "6h"
  • "24h"
  • "7d"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/workspaces/string/apps/string/services/string/jobs/details"
{  "at": 0,  "runs": [    {      "id": "string",      "name": "string",      "library": "bullmq",      "queue": "string",      "state": "running",      "attempt": 0,      "duration": 0,      "at": 0,      "error": "string",      "retryable": true    }  ],  "fired": [    {      "name": "string",      "library": "bullmq",      "queue": "string",      "at": 0,      "schedule": "string"    }  ],  "failures": [    {      "name": "string",      "library": "bullmq",      "at": 0,      "error": "string"    }  ],  "dead": [    {      "queue": "string",      "library": "bullmq",      "id": "string",      "name": "string",      "error": "string",      "tries": 0,      "at": 0    }  ],  "retry": [    "string"  ],  "notes": [    "string"  ]}

Read a worker's jobs and queues GET

Finds the job library the service uses and reads it: BullMQ, Sidekiq and Celery state in a Redis service of the same app, RabbitMQ queues, and Sidekiq and Celery job lines in the service's own logs. Returns finished and failed runs per step, each job type with its failure share, run-time p95 and newest outcomes, repeat and cron schedules, and each queue with its waiting jobs, rates, oldest job, consumers and dead letters. `searched` says where Monitor looked and what it found; nothing is invented when nothing is found. Works on a worker, a Redis or a RabbitMQ service. Failure texts need readServiceJobDetails.

Retry failed BullMQ jobs POST

Moves one failed job, or every failed job of a BullMQ queue, back to the queue's waiting list through the bullmq library, so the app's workers run it again. BullMQ 5 or later only; Sidekiq, Celery and RabbitMQ have no retry here. Requires the developer role.