v2.4latest

Workers

Workers register themselves with a heartbeat. The API only reads them: to stop one, send it a signal or scale your deployment.

API referenceBase URL https://api.sextant.example/v21 endpoint

The Worker object

idstring

Unique id, prefixed wrk_.

hoststring

Reported hostname.

queuesarray

Queues this worker pulls from.

busyinteger

Jobs running right now.

last_heartbeat_atstring

Last heartbeat, UTC.

List workers

GET/workers

Returns workers whose last heartbeat is less than 90 seconds old.

Required scope workers:read

Query parameters

queuestring optional

Only workers that pull from this queue.

Request

cURLShell

curl https://api.sextant.example/v2/workers?limit=20 \
  -H "Authorization: Bearer $SEXTANT_TOKEN"

NodeTypeScript

const result = await sextant.workers.list({
  limit: 20,
});

PythonPython

result = client.workers.list(limit=20)

GoGo

result, err := client.Workers.List(ctx, &sextant.ListParams{Limit: 20})
if err != nil {
	return err
}

Responses

Live workers.

200JSON

{
  "data": [
    {
      "id": "wrk_a91c7e",
      "host": "worker-3.internal",
      "version": "2.4.1",
      "queues": [
        "emails",
        "default"
      ],
      "concurrency": 20,
      "busy": 12,
      "started_at": "2026-10-19T22:01:12Z",
      "last_heartbeat_at": "2026-10-20T09:15:10Z"
    }
  ]
}