Brix Emergency Templates API

openapi: 3.2.0
info:
  title: Brix Emergency Templates 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: emergency-templates
paths:
  /v1/emergency-templates:
    get:
      operationId: listEmergencyTemplates
      tags:
      - emergency-templates
      summary: List emergency templates
      description: List pre-configured emergency recipes, such as Lockdown, Severe weather, or Fire drill, used for one-click triggering. A template with `prestage` set to true has its content cached on every screen in scope in advance, before it is ever triggered.
      x-brix-permission: emergency-override.view
      x-brix-schema: verified
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/EmergencyTemplate'
                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:
        - emergency-override.view
    post:
      operationId: createEmergencyTemplate
      tags:
      - emergency-templates
      summary: Create an emergency template
      description: Create a reusable emergency recipe with a `name`, `contentKind`, `contentId`, `scope`, `severity`, and an optional `prestage` flag. Trigger it later with POST /v1/emergencies/from-template/:templateId.
      x-brix-permission: emergency-override.edit
      x-brix-schema: verified
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  description: Default "Untitled template".
                  type: string
                headline:
                  description: Default "Emergency".
                  type: string
                body:
                  type: string
                severity:
                  description: Default `critical`.
                  type: string
                  enum:
                  - info
                  - warning
                  - critical
                contentKind:
                  type: string
                  enum:
                  - media
                  - creative
                  - playlist
                  - app
                contentId:
                  type: string
                scopeKind:
                  description: Default `all`.
                  type: string
                  enum:
                  - all
                  - node
                  - screens
                scopeNodeId:
                  description: 'Required with `scopeKind: node`.'
                  type: string
                nodeId:
                  description: 'Home location. Default: the API key''s location, else the workspace root.'
                  type: string
                prestage:
                  type: boolean
      responses:
        '201':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/EmergencyTemplate'
                required:
                - data
        '401':
          description: Missing, expired or revoked bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Missing `emergency-override.edit` at the home or scope location.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: The content or a location does not exist in this workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: 'A content kind outside media/creative/playlist/app, a half content pointer, or `scopeKind: node` without `scopeNodeId`.'
          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:
        - emergency-override.edit
  /v1/emergency-templates/{id}:
    delete:
      operationId: deleteEmergencyTemplate
      tags:
      - emergency-templates
      summary: Delete an emergency template
      description: 'Delete an emergency template. Emergencies already triggered from it are unaffected.


        **Notes.**

        - Needs `emergency-override.edit`; there is no `.delete` permission for templates.'
      x-brix-permission: emergency-override.edit
      x-brix-schema: verified
      x-brix-notes:
      - Needs `emergency-override.edit`; there is no `.delete` permission for templates.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Emergency template id.
        example: etpl_6f7a8b9c0d1e2f3a
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      deleted:
                        type: boolean
                        const: true
                    required:
                    - id
                    - deleted
                required:
                - data
        '401':
          description: Missing, expired or revoked bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Missing `emergency-override.edit` at the template's location.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such template in this workspace.
          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:
        - emergency-override.edit
    patch:
      operationId: updateEmergencyTemplate
      tags:
      - emergency-templates
      summary: Update an emergency template
      description: 'Edit an emergency template''s content, scope, severity, or prestaging setting.


        **Notes.**

        - Answers only `{ id }`, not the updated template; read it back with the list. A `severity` outside `critical`/`warning`/`info` is ignored.'
      x-brix-permission: emergency-override.edit
      x-brix-schema: verified
      x-brix-notes:
      - Answers only `{ id }`, not the updated template; read it back with the list. A `severity` outside `critical`/`warning`/`info` is ignored.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Emergency template id.
        example: etpl_6f7a8b9c0d1e2f3a
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  description: Default "Untitled template".
                  type: string
                headline:
                  description: Default "Emergency".
                  type: string
                body:
                  description: Empty or null clears it.
                  anyOf:
                  - type: string
                  - type: 'null'
                severity:
                  description: Default `critical`.
                  type: string
                  enum:
                  - info
                  - warning
                  - critical
                contentKind:
                  type: string
                  enum:
                  - media
                  - creative
                  - playlist
                  - app
                contentId:
                  type: string
                scopeKind:
                  description: Default `all`.
                  type: string
                  enum:
                  - all
                  - node
                  - screens
                scopeNodeId:
                  anyOf:
                  - type: string
                  - type: 'null'
                nodeId:
                  description: Move the template; you need `emergency-override.edit` at the destination too.
                  anyOf:
                  - type: string
                  - type: 'null'
                prestage:
                  type: boolean
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                    required:
                    - id
                required:
                - data
        '401':
          description: Missing, expired or revoked bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Missing `emergency-override.edit` at the template's location or at the destination.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such template, or the content or a location does not exist in this workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: An empty `name` or `headline`, a bad content pointer, or a scope that cannot be fired.
          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:
        - emergency-override.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.
    EmergencyTemplate:
      type: object
      properties:
        id:
          type: string
          description: Emergency template id.
          examples:
          - etpl_7a8b9c0d1e2f3a4b
        spaceId:
          type: string
        name:
          type: string
        severity:
          type: string
          enum:
          - info
          - warning
          - critical
        headline:
          type: string
        body:
          anyOf:
          - type: string
          - type: 'null'
        contentKind:
          anyOf:
          - type: string
            enum:
            - media
            - creative
            - playlist
            - app
          - type: 'null'
        contentId:
          anyOf:
          - type: string
          - type: 'null'
        scopeKind:
          type: string
          enum:
          - all
          - node
          - screens
        scopeNodeId:
          anyOf:
          - type: string
          - type: 'null'
        nodeId:
          anyOf:
          - type: string
          - type: 'null'
          description: Home location (null = workspace root); permissions are checked here.
        prestage:
          type: boolean
          description: Content is cached on every in-scope screen before any trigger.
        createdAt:
          type: string
          description: ISO-8601 timestamp (UTC).
        updatedAt:
          type: string
          description: ISO-8601 timestamp (UTC).
        deletedAt:
          anyOf:
          - type: string
            description: ISO-8601 timestamp (UTC).
          - type: 'null'
      required:
      - id
      - spaceId
      - name
      - severity
      - headline
      - body
      - contentKind
      - contentId
      - scopeKind
      - scopeNodeId
      - nodeId
      - prestage
      - createdAt
      - updatedAt
      - deletedAt
      description: A pre-armed emergency recipe.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An API key (`ak_…`) or a user session token. API keys carry `resource.verb` permissions.