Skip to main content

Drain & Restart Supervisor

POST 

/api/v2/queue-admin/supervisors/:name/drain-restart

Mark a Horizon supervisor as draining and signal Horizon to terminate. The actual restart is left to the supervisord/deploy layer (which restarts crashed Horizon processes anyway).

The drain marker key is queue-admin:drain:{supervisor} with a TTL from config('queue-admin.drain.status_ttl_seconds') (default 600s). The TTL guarantees a crashed deploy doesn't leave the UI stuck in 'draining' forever.

The frontend polls drain-status while the marker exists. This endpoint is fire-and-forget — Horizon's terminate signal is best-effort (we don't fail the request if the artisan call throws).

Authentication: Requires Bearer token.

Request

Responses

Successful response