Brix Connectors API

openapi: 3.2.0
info:
  title: Brix Connectors 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: Connectors
paths:
  /v1/connectors:
    get:
      operationId: listConnectors
      tags:
      - Connectors
      summary: List connector types
      description: 'List the data-source connector types: the `type` to use when you create a data source, its label and category, and whether it is available yet.'
      x-brix-permission: integration.view
      x-brix-schema: verified
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Connector'
                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:
        - integration.view
  /v1/connectors/probe:
    post:
      operationId: createConnectorProbe
      tags:
      - Connectors
      summary: Test a connector URL
      description: 'Test whether the platform can reach a given endpoint, behind the Test connection action used before creating a data source. The request is made from the server rather than the browser. Requests to private or internal network addresses are blocked.


        Sends a GET to the URL from the server and returns the status and the start of the body. Rate limited to 20 calls a minute.


        **Notes.**

        - A URL that cannot be reached is not an HTTP error: the answer is 200 with `ok: false`, `status: 0` and `error`.

        - A blocked private or internal address answers 400 with the `{ data: { ok: false, status: 0, error } }` body, not the usual error body.'
      x-brix-permission: integration.create
      x-brix-schema: verified
      x-brix-notes:
      - 'A URL that cannot be reached is not an HTTP error: the answer is 200 with `ok: false`, `status: 0` and `error`.'
      - 'A blocked private or internal address answers 400 with the `{ data: { ok: false, status: 0, error } }` body, not the usual error body.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  description: An http(s) URL on the public internet.
                token:
                  description: 'Sent as `Authorization: Bearer <token>`. Not stored.'
                  type: string
              required:
              - url
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    anyOf:
                    - type: object
                      properties:
                        status:
                          type: integer
                          description: HTTP status the URL answered with.
                        ok:
                          type: boolean
                          description: The status was 2xx.
                        contentType:
                          anyOf:
                          - type: string
                          - type: 'null'
                        sample:
                          type: string
                          description: The first 4000 characters of the response body.
                        truncated:
                          type: boolean
                          description: The body was longer than `sample`.
                      required:
                      - status
                      - ok
                      - contentType
                      - sample
                      - truncated
                    - type: object
                      properties:
                        ok:
                          type: boolean
                          const: false
                        status:
                          type: number
                          const: 0
                        error:
                          type: string
                          description: Why the request did not complete (network failure, timeout, or a blocked address).
                      required:
                      - ok
                      - status
                      - error
                required:
                - data
        '400':
          description: '`bad_request`: the URL is not http(s). A private or internal address also answers 400, with the `data` body (`ok: false`, `status: 0`, `error`) instead of an error body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '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'
        '429':
          description: More than 20 calls in a minute.
          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:
        - integration.create
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.
    Connector:
      type: object
      properties:
        type:
          type: string
          description: The value for a data source's `type` (`http-json`, `csv`, `google-sheets`, …).
        label:
          type: string
        category:
          type: string
          description: Group the connector is listed under (`generic`, `celebrations`, …).
        available:
          type: boolean
          description: False for a connector that is listed as coming soon and cannot be used yet.
      required:
      - type
      - label
      - category
      - available
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An API key (`ak_…`) or a user session token. API keys carry `resource.verb` permissions.