Workers
Job worker management and status monitoring. These are cluster-infrastructure endpoints: they broadcast commands to the job-worker threads over the cluster IPC bus.
Every endpoint on this page requires a manager-tenant superuser. They are operational tools and are not exercised in the captured examples (they depend on live worker threads and the IPC bus).
GET /api/job-workers
List the known job workers and their current status.
Authentication: Required
Permissions: Manager superuser
Query Parameters:
| Parameter | Type | Default | Description |
|---|---|---|---|
timeout | integer (ms) | 30000 | How long to wait for workers to reply. Max 119000 |
Response:
A plain array of status entries, one per worker that replied. Each entry carries workerId and IPC round-trip timestamps (messageSentAt, messageReceivedAt, replySentAt, replyReceivedAt), plus the worker's reported status data; entries that timed out carry timeout/error instead. When no workers are known, the response is an empty array.
PUT /api/job-workers/{id}
Reconfigure a specific job worker (fire-and-forget IPC command).
Authentication: Required
Permissions: Manager superuser
Path Parameters:
| Parameter | Type | Description |
|---|---|---|
id | string | Worker (channel) id |
Request Body:
| Field | Type | Description |
|---|---|---|
maxActiveJobs | integer | Max concurrent jobs. -1 means unlimited; 0 is not allowed |
Example:
{ "maxActiveJobs": 10 }
Response:
Responds 200 with an empty body once the command is dispatched.
POST /api/job-workers/{id}/_stop
Stop a specific job worker.
Authentication: Required
Permissions: Manager superuser
Path Parameters:
| Parameter | Type | Description |
|---|---|---|
id | string | Worker (channel) id |
Response:
Responds 200 with an empty body.
POST /api/job-workers/{id}/_start
Start a specific job worker.
Authentication: Required
Permissions: Manager superuser
Path Parameters:
| Parameter | Type | Description |
|---|---|---|
id | string | Worker (channel) id |
Response:
Responds 200 with an empty body.
PUT /api/job-worker
Configure the job worker on the current thread.
Authentication: Required
Permissions: Manager superuser
Request Body:
| Field | Type | Description |
|---|---|---|
maxActiveJobs | integer | Max concurrent jobs. -1 means unlimited; 0 is not allowed |
Response:
Responds 200 with an empty body, or 404 if this thread has no job worker.
POST /api/job-worker-stop
Stop the current thread's job worker.
Authentication: Required
Permissions: Manager superuser
Response:
Responds 200 with an empty body, or 404 if this thread has no job worker.
POST /api/job-worker-start
Start the current thread's job worker.
Authentication: Required
Permissions: Manager superuser
Response:
Responds 200 with an empty body, or 404 if this thread has no job worker.