Brix Power Policies API

openapi: 3.2.0
info:
  title: Brix Power Policies 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: power-policies
paths:
  /v1/power-policies:
    get:
      operationId: listPowerPolicies
      tags:
      - power-policies
      summary: List power policies
      description: 'List the power policies configured for your workspace. Each policy defines an open and close window for the screens using it.


        **Notes.**

        - Needs the permission at the workspace root: a location-scoped key is refused.'
      x-brix-permission: screen.view
      x-brix-schema: verified
      x-brix-notes:
      - 'Needs the permission at the workspace root: a location-scoped key is refused.'
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PowerPolicy'
                required:
                - data
              example:
                data:
                - id: ppol_1a2b3c4d5e6f7a8b
                  spaceId: space_1a2b3c4d5e6f7a8b
                  name: Store hours
                  description: Open 8 to 22
                  windows:
                    mon:
                      start: 08:00
                      end: '22:00'
                    tue:
                      start: 08:00
                      end: '22:00'
                      volume: 40
                  rebootHourLocal: 4
                  timezone: Europe/London
                  createdAt: '2026-09-28T09:00:00.000Z'
                  updatedAt: '2026-09-28T09:00:00.000Z'
                  deletedAt: null
                  screenCount: 12
        '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
    post:
      operationId: createPowerPolicy
      tags:
      - power-policies
      summary: Create a power policy
      description: 'Create a named power policy that defines when screens using it should power on and off.


        **Notes.**

        - Needs the permission at the workspace root: a location-scoped key is refused.'
      x-brix-permission: screen.edit
      x-brix-schema: verified
      x-brix-notes:
      - 'Needs the permission at the workspace root: a location-scoped key is refused.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  description: 'Default on create: `Untitled policy`.'
                  type: string
                description:
                  anyOf:
                  - type: string
                  - type: 'null'
                windows:
                  type: object
                  properties:
                    mon:
                      anyOf:
                      - $ref: '#/components/schemas/OpenWindow'
                      - type: 'null'
                    tue:
                      anyOf:
                      - $ref: '#/components/schemas/OpenWindow'
                      - type: 'null'
                    wed:
                      anyOf:
                      - $ref: '#/components/schemas/OpenWindow'
                      - type: 'null'
                    thu:
                      anyOf:
                      - $ref: '#/components/schemas/OpenWindow'
                      - type: 'null'
                    fri:
                      anyOf:
                      - $ref: '#/components/schemas/OpenWindow'
                      - type: 'null'
                    sat:
                      anyOf:
                      - $ref: '#/components/schemas/OpenWindow'
                      - type: 'null'
                    sun:
                      anyOf:
                      - $ref: '#/components/schemas/OpenWindow'
                      - type: 'null'
                  description: Open window per weekday. `null` or an absent day is closed. A malformed day is dropped (closed), not refused.
                rebootHourLocal:
                  description: 0–23; rounded and clamped. Null (or a value that is not a number) turns the restart off.
                  anyOf:
                  - type: number
                  - type: 'null'
                timezone:
                  description: IANA time zone (`Europe/London`). An unknown zone is refused with 422.
                  anyOf:
                  - type: string
                  - type: 'null'
      responses:
        '201':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/PowerPolicy'
                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'
        '422':
          description: Unknown `timezone`.
          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
  /v1/power-policies/{id}:
    get:
      operationId: getPowerPolicy
      tags:
      - power-policies
      summary: Get a power policy
      description: 'Get one power policy by its ID.


        **Notes.**

        - Needs the permission at the workspace root: a location-scoped key is refused.'
      x-brix-permission: screen.view
      x-brix-schema: verified
      x-brix-notes:
      - 'Needs the permission at the workspace root: a location-scoped key is refused.'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Power policy id.
        example: ppol_1a2b3c4d5e6f7a8b
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/PowerPolicy'
                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 power policy 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:
        - screen.view
    patch:
      operationId: updatePowerPolicy
      tags:
      - power-policies
      summary: Update a power policy
      description: 'Update a power policy''s open and close windows, reboot hour, time zone, or name.


        **Notes.**

        - `screenCount` in this response is always 0; read the policy to get the real count.

        - An empty `name` keeps the current name.

        - Needs the permission at the workspace root: a location-scoped key is refused.'
      x-brix-permission: screen.edit
      x-brix-schema: verified
      x-brix-notes:
      - '`screenCount` in this response is always 0; read the policy to get the real count.'
      - An empty `name` keeps the current name.
      - 'Needs the permission at the workspace root: a location-scoped key is refused.'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Power policy id.
        example: ppol_1a2b3c4d5e6f7a8b
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  description: 'Default on create: `Untitled policy`.'
                  type: string
                description:
                  anyOf:
                  - type: string
                  - type: 'null'
                windows:
                  type: object
                  properties:
                    mon:
                      anyOf:
                      - $ref: '#/components/schemas/OpenWindow'
                      - type: 'null'
                    tue:
                      anyOf:
                      - $ref: '#/components/schemas/OpenWindow'
                      - type: 'null'
                    wed:
                      anyOf:
                      - $ref: '#/components/schemas/OpenWindow'
                      - type: 'null'
                    thu:
                      anyOf:
                      - $ref: '#/components/schemas/OpenWindow'
                      - type: 'null'
                    fri:
                      anyOf:
                      - $ref: '#/components/schemas/OpenWindow'
                      - type: 'null'
                    sat:
                      anyOf:
                      - $ref: '#/components/schemas/OpenWindow'
                      - type: 'null'
                    sun:
                      anyOf:
                      - $ref: '#/components/schemas/OpenWindow'
                      - type: 'null'
                  description: Open window per weekday. `null` or an absent day is closed. A malformed day is dropped (closed), not refused.
                rebootHourLocal:
                  description: 0–23; rounded and clamped. Null (or a value that is not a number) turns the restart off.
                  anyOf:
                  - type: number
                  - type: 'null'
                timezone:
                  description: IANA time zone (`Europe/London`). An unknown zone is refused with 422.
                  anyOf:
                  - type: string
                  - type: 'null'
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/PowerPolicy'
                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 power policy in this workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Unknown `timezone`.
          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
  /v1/power-policies/{id}/delete:
    post:
      operationId: createPowerPolicyDelete
      tags:
      - power-policies
      summary: Delete a power policy
      description: 'Delete a power policy. Screens that use it go back to their own operating hours. A deleted policy cannot be restored.


        **Notes.**

        - A POST to `/delete`, not `DELETE`. Screens that use the policy keep the link and use their own operating hours until they get another policy. There is no restore route.

        - Needs the permission at the workspace root: a location-scoped key is refused.'
      x-brix-permission: screen.edit
      x-brix-schema: verified
      x-brix-notes:
      - A POST to `/delete`, not `DELETE`. Screens that use the policy keep the link and use their own operating hours until they get another policy. There is no restore route.
      - 'Needs the permission at the workspace root: a location-scoped key is refused.'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Power policy id.
        example: ppol_1a2b3c4d5e6f7a8b
      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: The token lacks the permission this operation needs (see `x-brix-permission`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such power policy 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:
        - screen.edit
components:
  schemas:
    OpenWindow:
      type: object
      properties:
        start:
          type: string
          description: Opening time, `HH:MM` 24-hour, local time.
        end:
          type: string
          description: Closing time, `HH:MM`. An `end` at or before `start` runs past midnight.
        volume:
          description: Volume 0–100 while open; absent or null keeps the screen's own.
          anyOf:
          - type: integer
          - type: 'null'
        brightness:
          description: Backlight 0–100 while open; absent or null keeps the screen's own.
          anyOf:
          - type: integer
          - type: 'null'
        muted:
          description: Mute (true) or unmute (false) while open; absent or null keeps the screen's own.
          anyOf:
          - type: boolean
          - type: 'null'
      required:
      - start
      - end
    WeeklyWindows:
      type: object
      properties:
        mon:
          $ref: '#/components/schemas/OpenWindow'
        tue:
          $ref: '#/components/schemas/OpenWindow'
        wed:
          $ref: '#/components/schemas/OpenWindow'
        thu:
          $ref: '#/components/schemas/OpenWindow'
        fri:
          $ref: '#/components/schemas/OpenWindow'
        sat:
          $ref: '#/components/schemas/OpenWindow'
        sun:
          $ref: '#/components/schemas/OpenWindow'
      description: Open window per weekday (`mon` … `sun`). A day that is absent is closed.
    PowerPolicy:
      type: object
      properties:
        id:
          type: string
          description: Power policy id.
          examples:
          - ppol_1a2b3c4d5e6f7a8b
        spaceId:
          type: string
        name:
          type: string
        description:
          anyOf:
          - type: string
          - type: 'null'
        windows:
          $ref: '#/components/schemas/WeeklyWindows'
        rebootHourLocal:
          anyOf:
          - type: integer
          - type: 'null'
          description: Hour (0–23, local time) the device restarts each day; null = no scheduled restart.
        timezone:
          anyOf:
          - type: string
          - type: 'null'
          description: IANA time zone the windows use; null = each screen's own time zone.
        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'
          description: Always null on these reads.
        screenCount:
          type: integer
          description: Screens that use this policy.
      required:
      - id
      - spaceId
      - name
      - description
      - windows
      - rebootHourLocal
      - timezone
      - createdAt
      - updatedAt
      - deletedAt
      - screenCount
    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.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An API key (`ak_…`) or a user session token. API keys carry `resource.verb` permissions.