API Reference

Send control to a worker on its next heartbeat.

Faktory’s BEAT carries quiet/terminate; here it is one column on the worker row, read back by the heartbeat upsert. The list endpoint separates the pending command from the worker-acknowledged status. quiet pauses admission (in-flight work finishes), resume resumes, terminate shuts the worker down gracefully, and resign releases only this worker’s singleton duty leases for immediate takeover. An operator drains a fleet without a deploy. null clears a pending signal.

POST

workers

{worker_id}

signal

Error

A valid request URL is required to generate request examples

Headers

Idempotency-Key

string

required

Required on every mutating request. A double-clicked Retry, or a proxy retrying a POST, must not enqueue the job twice. Keys are retained long enough to cover a client retry window and the response is replayed verbatim.

Path Parameters

worker_id

string

required

Body

application/json

command

enum<string> | null

Available options:

quiet,

resume,

restart,

terminate,

resign,

null

Response

Signal set

Error

A valid request URL is required to generate request examples