Skip to content

workers ​

3 endpoints at a glance
MethodPathSummary
GET/admin/workers/List Workers
POST/admin/workers/{key}/recoverRecover Worker
POST/admin/workers/{key}/stop-allStop All Active

workers​


List Workers​

GET
/admin/workers/

Live snapshot of all in-process workers.

Sync route — FastAPI offloads it to the threadpool, so the
blocking Mongo finds are fine here. Each descriptor carries the
consumer-task liveness, in-memory queue depth, the in-flight
item, and the DB-backed queued / running rows (the
actionable "should be moving" set) plus a deep-link to the
full per-subsystem admin panel.

Each descriptor is computed defensively: if one fails (e.g. a Mongo
read times out under a pathological backlog) it degrades to a stub
rather than failing the whole snapshot.

Parameters​

Header Parameters

authorization
x-api-key

Responses​

Successful Response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground​

Headers

Samples​


Stop All Active​

POST
/admin/workers/{key}/stop-all

Stop every queued/running row in this worker's queue.

Iterates the DB-backed active rows and invokes the subsystem's
request_stop(...) for each — the same cooperative-stop
method the per-row Stop button calls. Queued rows are cancelled
before they start; running rows finish with partial progress kept.
One audit row per click, with counts in the result. Idempotent —
re-running after the rows have already stopped finds nothing and
returns a no-op summary.

400 for enrichment / measurements_latest_backfill (no
per-row stop — both workers are globally rate-paced, no per-entity
job to cancel); 404 for an unknown key.

Parameters​

Header Parameters

authorization
x-api-key

Path Parameters

key*
Type
string
Required

Responses​

Successful Response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground​

Headers
Variables
Key
Value

Samples​


Recover Worker​

POST
/admin/workers/{key}/recover

Re-enqueue orphaned queued / running jobs for one
worker. Dispatches to that worker's own recovery (the same one
its start() runs). Idempotent — safe to click any time, a
double-enqueue no-ops at the claim.

Parameters​

Header Parameters

authorization
x-api-key

Path Parameters

key*
Type
string
Required

Responses​

Successful Response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground​

Headers
Variables
Key
Value

Samples​


Atlas — built on RIPE Atlas data.