Brix Alert Events API

openapi: 3.2.0
info:
  title: Brix Alert Events API
  version: '1'
  summary: 'Control plane for Brix digital signage: screens, content, playlists, schedules, casts and emergencies.'
  description: 'Generated from the route table the API actually mounts

    (`apps/api/routes.snapshot.json`), the description each route is required to

    carry (`tests/contracts/route-registry.json`), and request/response schemas

    (`apps/api/src/openapi/`). CI enforces all three, so this document cannot list a

    route that does not exist or omit one that does.


    **Schemas.** 447 operations carry request and response schemas

    (`x-brix-schema: verified`). Each is checked in CI against the response the

    real handler returns — a missing, mistyped or undeclared field fails the build.

    The remaining operations are route-level only (`x-brix-schema: none`): their

    path, method, permission and purpose are exact, but the shape of `data` is not

    yet modelled, and we would rather say so than publish a schema that validates

    against nothing. Objects are open: a new field is not a breaking change.


    **Envelope.** Success bodies are `{ "data": … }`. Failures are

    `{ "error": "", "message": "…" }`, plus `requestId` on a 5xx.

    Many list routes page opt-in (see each operation): pass `?limit=` and

    follow `nextCursor` via `?cursor=` until it is null.


    **Authentication.** `Authorization: Bearer ` with an API key

    (`ak_…`, created in the console under Settings → API & MCP) or a user session. An

    API key carries a creator-chosen set of `resource.verb` permissions and may be

    pinned to one location''s subtree; a key can never be granted a permission its

    creator does not hold. The permission an operation needs is in

    `x-brix-permission` and in its security requirement.


    **Tenancy.** Every request resolves to one workspace. A resource belonging to

    another tenant returns 404, never 403, so a response never confirms that an

    account exists.


    **Rate limits.** A 429 carries `Retry-After`; a 503 `database_busy` means retry

    after the `Retry-After` interval.'
servers:
- url: https://api.brixsignage.com
  description: Production
security:
- bearerAuth: []
tags:
- name: alert-events
paths:
  /v1/alert-events:
    get:
      operationId: listAlertEvents
      tags:
      - alert-events
      summary: List alert events
      description: 'List alerts that have fired against your screens, each combined with the screen''s name. This endpoint is read-only: alerts open automatically when a condition is detected and close automatically on recovery. Only currently open alerts are returned, as a limited list, so a long history does not push them out.


        Open events (up to 300, newest first) followed by recently closed ones (up to 300). Not paginated.


        **Notes.**

        - The route-registry description names `alert-rule.view`, but the route is gated by `screen.view`; `screen.view` is what a key needs.'
      x-brix-permission: screen.view
      x-brix-schema: verified
      x-brix-notes:
      - The route-registry description names `alert-rule.view`, but the route is gated by `screen.view`; `screen.view` is what a key needs.
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/AlertEvent'
                required:
                - data
        '401':
          description: Missing, expired or revoked bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The token lacks the permission this operation needs (see `x-brix-permission`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Server error. The body carries a `requestId` to quote to support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearerAuth:
        - screen.view
  /v1/alert-events/{id}/close:
    post:
      operationId: closeAlertEvent
      tags:
      - alert-events
      summary: Close an alert event
      description: 'Manually close an alert event before it would close automatically on recovery. Access is checked against the screen where the alert fired.


        **Notes.**

        - The route-registry description names `alert-rule.edit`, but the route is gated by `screen.edit` at the event''s location.'
      x-brix-permission: screen.edit
      x-brix-schema: verified
      x-brix-notes:
      - The route-registry description names `alert-rule.edit`, but the route is gated by `screen.edit` at the event's location.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Alert event id.
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/AlertEvent'
                required:
                - data
        '401':
          description: Missing, expired or revoked bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The token lacks the permission this operation needs (see `x-brix-permission`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such event.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: '`already_closed`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Server error. The body carries a `requestId` to quote to support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearerAuth:
        - screen.edit
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: 'Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …'
        message:
          description: Human-readable explanation. Safe to show an operator.
          type: string
        requestId:
          description: 'Present on 5xx: quote it to support.'
          type: string
      required:
      - error
      additionalProperties: {}
      description: Error envelope returned by every failing request.
    AlertEvent:
      type: object
      properties:
        id:
          type: string
          description: Alert event id.
        code:
          type: string
          description: What fired, e.g. `connection-lost`, `display-off`, `storage-critical`.
        severity:
          type: string
          description: '`info`, `warning` or `critical`.'
        screenId:
          type: string
        screenName:
          type: string
          description: '`(unknown screen)` if the screen is gone.'
        message:
          type: string
        nextAction:
          type: string
          description: Suggested next step; may be empty.
        openedAt:
          type: string
          description: ISO-8601 timestamp (UTC).
        closedAt:
          anyOf:
          - type: string
            description: ISO-8601 timestamp (UTC).
          - type: 'null'
          description: Null while open.
        detail:
          anyOf:
          - type: object
            properties:
              kind:
                type: string
            required:
            - kind
            additionalProperties: {}
          - type: 'null'
          description: Structured detail keyed by `kind` (`recovery`, `outage-history`, `network-unstable`, `display-off`), or null.
      required:
      - id
      - code
      - severity
      - screenId
      - screenName
      - message
      - nextAction
      - openedAt
      - closedAt
      - detail
      description: One firing of an alert rule against a screen.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An API key (`ak_…`) or a user session token. API keys carry `resource.verb` permissions.