> ## 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.

# Act on an explicit list of job IDs. The common case.

> River UI lets you tick 12 rows and hit Retry. The selector-based /jobs/bulk
below cannot express that, and it was the only bulk route this spec had —
selecting specific rows is what operators actually do, while filter-based bulk is
the rarer and far more dangerous operation. Synchronous, because the set is
bounded by max_ids.




## OpenAPI

````yaml /api/headgate.openapi.yaml post /jobs/actions
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:
  /jobs/actions:
    post:
      summary: Act on an explicit list of job IDs. The common case.
      description: >
        River UI lets you tick 12 rows and hit Retry. The selector-based
        /jobs/bulk

        below cannot express that, and it was the only bulk route this spec had
        —

        selecting specific rows is what operators actually do, while
        filter-based bulk is

        the rarer and far more dangerous operation. Synchronous, because the set
        is

        bounded by max_ids.
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - action
                - ids
              properties:
                action:
                  type: string
                  enum:
                    - retry
                    - archive
                    - delete
                    - cancel
                ids:
                  type: array
                  items:
                    type: string
                  maxItems: 1000
      responses:
        '200':
          description: Per-job action results.
          content:
            application/json:
              schema:
                type: object
                properties:
                  succeeded:
                    type: array
                    items:
                      type: string
                  failed:
                    type: array
                    description: >-
                      Per-id failure — a job that finished before the click is
                      not an error for the whole batch.
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        reason:
                          type: string
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: true
      schema:
        type: string
      description: >
        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.

````