Skip to main content
GET
/
api
/
workers
GET /api/workers
curl --request GET \
  --url https://app.sluice.sh/api/api/workers

Documentation Index

Fetch the complete documentation index at: https://docs.sluice.sh/llms.txt

Use this file to discover all available pages before exploring further.

Returns a paginated list of workers with their current status and performance metrics.

​
Authentication

Session cookie (dashboard).

​
Query parameters

ParameterTypeDefaultDescription
pageinteger1Page number (1-indexed).
limitinteger50Results per page (1–100).
connectionIdstring—Filter by connection UUID.
frameworkstring—Filter by framework: celery, bullmq, sidekiq.
statestring—Filter by worker state: online, busy, idle, offline.
sortBystringhostnameSort field: hostname, state, activeJobs, lastHeartbeat, taskRate.
sortOrderstringascSort direction: asc or desc.

​
Response

{
  "data": [
    {
      "id": "d4e5f6a7-b8c9-0123-def0-123456789abc",
      "externalId": "celery@worker-1",
      "framework": "celery",
      "connectionId": "550e8400-e29b-41d4-a716-446655440000",
      "hostname": "celery@worker-1",
      "pid": 12345,
      "state": "online",
      "lastHeartbeat": "2026-02-27T10:30:00.000Z",
      "concurrency": 8,
      "activeJobs": 3,
      "queues": ["default", "payments"],
      "metadata": {
        "software": "celery 5.6.2 (dawn-chorus)",
        "pool": "prefork"
      },
      "taskRate": 4.2,
      "processedTotal": 15230,
      "extensions": {},
      "createdAt": "2026-02-20T08:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 4,
    "totalPages": 1
  }
}

​
Worker fields

FieldTypeDescription
idstringSluice-generated UUID.
externalIdstringFramework-native worker ID (Celery hostname, e.g., celery@worker-1).
frameworkstringAlways celery in V0.
connectionIdstringConnection this worker belongs to.
hostnamestringWorker hostname.
pidinteger?Worker process ID.
statestringWorker state: online, busy, idle, offline.
lastHeartbeatstring?ISO 8601 — time of last heartbeat. Workers that miss heartbeats for >6 seconds are marked offline.
concurrencyinteger?Maximum concurrent jobs this worker can process.
activeJobsintegerNumber of jobs currently being processed.
queuesstring[]Queues this worker consumes from.
metadataobjectFramework-specific metadata — software version, pool type, etc.
taskRatenumber?Jobs processed per minute over a rolling 1-hour window.
processedTotalinteger?Cumulative jobs processed since the worker came online.
extensionsobjectFramework-specific data.
createdAtstringISO 8601 — when this worker was first seen.