> ## Documentation Index
> Fetch the complete documentation index at: https://headgate.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# List live workers and their acknowledged control state.



## OpenAPI

````yaml /api/headgate.openapi.yaml get /workers
openapi: 3.1.0
info:
  title: headgate control API
  version: 0.1.0
  description: >
    The web UI is one client of this control API and gets no

    privileged access — asynqmon reads Redis directly, which is why its
    compatibility

    note is three minor versions stale.


    Both the Go and Rust implementations serve this spec, and the conformance
    suite

    asserts identical responses. Every list endpoint is bounded to prevent
    inspection

    from becoming an unbounded store operation: asynq's

    GetQueueInfo is O(number of groups) and has pinned Redis CPU for seconds in

    production. Monitoring caused the outage.


    DERIVED FROM THE ARCHITECTURE, NOT FROM A PREDECESSOR'S UI. The first draft
    of this

    spec was the asynq Inspector surface -- list by state, act on one job, pause
    a queue

    -- with new nouns bolted on. That inherited three problems: it omitted bulk

    operations, history, and enqueue (which asynq and apalis-board respectively
    DO have),

    and more importantly it had no endpoint for the question this system's own
    design

    creates. When dequeue is an admission decision, the operator's first
    question is not

    "what is in the queue" but "why is THIS job not running" -- see
    /jobs/{id}/admission.

    No predecessor needs that endpoint because no predecessor has a gate.
servers:
  - url: /api/v1
security: []
paths:
  /workers:
    get:
      summary: List live workers and their acknowledged control state.
      parameters:
        - $ref: '#/components/parameters/ControlLimit'
        - $ref: '#/components/parameters/ControlCursor'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    worker_id:
                      type: string
                    host:
                      type: string
                    pid:
                      type: integer
                    queues:
                      type: array
                      items:
                        type: string
                    concurrency:
                      type: integer
                    inflight:
                      type: integer
                    heartbeat_at_ms:
                      type: integer
                    status:
                      type: string
                      enum:
                        - running
                        - quiet
                        - restarting
                        - terminating
                    duties_active:
                      type: boolean
                    pending_command:
                      type:
                        - string
                        - 'null'
                      enum:
                        - quiet
                        - resume
                        - restart
                        - terminate
                        - resign
                        - null
components:
  parameters:
    ControlLimit:
      name: limit
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 200
        default: 200
    ControlCursor:
      name: cursor
      in: query
      description: Zero-based offset returned in the x-next-cursor response header.
      schema:
        type: integer
        minimum: 0
        default: 0

````