Brix Data Sources API

openapi: 3.2.0
info:
  title: Brix Data Sources 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: Data Sources
paths:
  /v1/data-sources:
    get:
      operationId: listDataSources
      tags:
      - Data Sources
      summary: List data sources
      description: 'List the data feeds, such as spreadsheets, APIs, and other connectors, that creatives and apps can connect to. Credentials are encrypted at rest and are never returned.


        **Notes.**

        - Not paginated: every data source you can see comes back in one response (no `?limit`/`?cursor`, unlike the app instance, creative and layout lists).'
      x-brix-permission: integration.view
      x-brix-schema: verified
      x-brix-notes:
      - 'Not paginated: every data source you can see comes back in one response (no `?limit`/`?cursor`, unlike the app instance, creative and layout lists).'
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/DataSource'
                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
    post:
      operationId: createDataSource
      tags:
      - Data Sources
      summary: Create a data source
      description: 'Connect a data feed with a `name`, a connector `type`, a `config`, and an optional `nodeId`. Any credentials included in `config` are encrypted at rest. Test the configuration first with POST /v1/data-sources/test before creating it.


        **Notes.**

        - Gated by `integration.edit`, not `integration.create`.'
      x-brix-permission: integration.edit
      x-brix-schema: verified
      x-brix-notes:
      - Gated by `integration.edit`, not `integration.create`.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                type:
                  type: string
                  description: 'Connector type from `GET /v1/connectors`. The value is not checked here: an unknown type fails at the first sync.'
                config:
                  type: object
                  propertyNames:
                    type: string
                  additionalProperties: {}
                  description: Connector settings (JSON). The keys depend on `type`. Credentials are encrypted at rest and every later read shows them as `••••••••`.
                nodeId:
                  description: Home location; null or absent = workspace root. The key needs the permission there.
                  anyOf:
                  - type: string
                  - type: 'null'
              required:
              - name
              - type
      responses:
        '201':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/DataSource'
                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: '`name` or `type` is missing, or `invalid_node`: the location is not 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:
        - integration.edit
  /v1/data-sources/{id}:
    delete:
      operationId: deleteDataSource
      tags:
      - Data Sources
      summary: Delete a data source
      description: Delete a data source. It can be restored later with POST /v1/data-sources/:id/restore. Creatives connected to it display their fallback values while it is deleted.
      x-brix-permission: integration.edit
      x-brix-schema: verified
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Data source id.
        example: ds_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: The token lacks the permission this operation needs (see `x-brix-permission`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such data source 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:
        - integration.edit
    get:
      operationId: getDataSource
      tags:
      - Data Sources
      summary: Get a data source
      description: Retrieve one data source, including its connector configuration, the time of its last sync, and its row schema. Secret values are redacted.
      x-brix-permission: integration.view
      x-brix-schema: verified
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Data source id.
        example: ds_6f7a8b9c0d1e2f3a
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/DataSource'
                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 data source 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:
        - integration.view
    patch:
      operationId: updateDataSource
      tags:
      - Data Sources
      summary: Update a data source
      description: 'Edit a data source''s name, connector configuration, or node.


        Send `••••••••` back for a credential to keep the stored value. To point the source at a different address or connector type, enter the credential again.'
      x-brix-permission: integration.edit
      x-brix-schema: verified
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Data source id.
        example: ds_6f7a8b9c0d1e2f3a
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                type:
                  description: A change of type needs `config` with the credentials entered again.
                  type: string
                config:
                  type: object
                  propertyNames:
                    type: string
                  additionalProperties: {}
                  description: Connector settings (JSON). The keys depend on `type`. Credentials are encrypted at rest and every later read shows them as `••••••••`.
                nodeId:
                  description: Move it; the key needs `integration.edit` at the destination too.
                  anyOf:
                  - type: string
                  - type: 'null'
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/DataSource'
                required:
                - data
        '401':
          description: Missing, expired or revoked bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: No `integration.edit` at the destination location.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such data source in this workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: '`conflict`: the type or config changed while this request ran. Nothing was saved; read the source again and resend.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: '`credential_reentry_required`: the change moves a masked credential to a new address or connector type (`fields` names what moved); or `invalid_node`: the destination is not 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:
        - integration.edit
  /v1/data-sources/{id}/restore:
    post:
      operationId: restoreDataSource
      tags:
      - Data Sources
      summary: Restore a deleted data source
      description: Restore a deleted data source connector. Apps and creatives connected to it begin receiving fresh data again the next time their content refreshes.
      x-brix-permission: integration.edit
      x-brix-schema: verified
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Data source id.
        example: ds_6f7a8b9c0d1e2f3a
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      restored:
                        type: boolean
                        const: true
                    required:
                    - id
                    - restored
                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 data source in this workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: '`not_deleted`: the data source is not in the recycle bin.'
          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.edit
  /v1/data-sources/{id}/sync:
    post:
      operationId: syncDataSource
      tags:
      - Data Sources
      summary: Sync a data source now
      description: 'Pull fresh data for one data source immediately instead of waiting for its regular schedule.


        Runs the connector once and caches the result. A connector failure is NOT an HTTP error: the answer is 200 with `synced: false` and the reason.'
      x-brix-permission: integration.edit
      x-brix-schema: verified
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Data source id.
        example: ds_6f7a8b9c0d1e2f3a
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    oneOf:
                    - type: object
                      properties:
                        id:
                          type: string
                        synced:
                          type: boolean
                          const: true
                      required:
                      - id
                      - synced
                    - type: object
                      properties:
                        id:
                          type: string
                        synced:
                          type: boolean
                          const: false
                        error:
                          type: string
                          description: Why the connector failed. Also stored as the source's `syncError`.
                      required:
                      - id
                      - synced
                      - error
                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 data source 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:
        - integration.edit
  /v1/data-sources/refresh-all:
    post:
      operationId: refreshAllDataSources
      tags:
      - Data Sources
      summary: Sync every data source
      description: 'Pull fresh data for every data source in the workspace immediately. This action is rate-limited to 5 requests per minute.


        Syncs, one after another, every data source the caller may edit. Rate limited to 5 calls a minute.'
      x-brix-permission: integration.edit
      x-brix-schema: verified
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      total:
                        type: integer
                      ok:
                        type: integer
                      failed:
                        type: integer
                    required:
                    - total
                    - ok
                    - failed
                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'
        '429':
          description: More than 5 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.edit
  /v1/data-sources/sheets-methods:
    get:
      operationId: listDataSourceSheetsMethods
      tags:
      - Data Sources
      summary: List Google Sheets sharing methods
      description: List the ways a Google Sheet can be shared with the platform, and the address to share it with. The response may include `publicLink`, `serviceAccount`, and `oauth`, depending on what the platform supports; a method is listed only if it is actually available. `serviceAccount` is not a secret; it is the address you enter into Google's Share dialog.
      x-brix-permission: integration.view
      x-brix-schema: verified
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      publicLink:
                        type: boolean
                        const: true
                        description: A sheet shared as "anyone with the link" always works.
                      serviceAccount:
                        anyOf:
                        - type: string
                        - type: 'null'
                        description: The address to share a private sheet with; null when this method is not available.
                      oauth:
                        type: boolean
                        description: A private sheet can be picked by signing in with Google.
                    required:
                    - publicLink
                    - serviceAccount
                    - oauth
                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/data-sources/test:
    post:
      operationId: testDataSource
      tags:
      - Data Sources
      summary: Test a data source config
      description: 'Validate a connector configuration without saving it. Returns `{ ok: true, preview }` on success or `{ ok: false, error }` on failure, so a misconfigured feed can be caught before it is created.


        Runs the connector once with a config that is not saved. A connector failure is NOT an HTTP error: the answer is 200 with `ok: false` and the reason. Rate limited to 20 calls a minute.'
      x-brix-permission: integration.edit
      x-brix-schema: verified
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                config:
                  type: object
                  propertyNames:
                    type: string
                  additionalProperties: {}
                  description: Connector settings (JSON). The keys depend on `type`. Credentials are encrypted at rest and every later read shows them as `••••••••`.
              required:
              - type
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    oneOf:
                    - type: object
                      properties:
                        ok:
                          type: boolean
                          const: true
                        preview:
                          type: string
                          description: The fetched data as JSON text, cut to 2000 characters.
                      required:
                      - ok
                      - preview
                    - type: object
                      properties:
                        ok:
                          type: boolean
                          const: false
                        error:
                          type: string
                          description: Why the connector failed, or that no connector has this `type`.
                      required:
                      - ok
                      - error
                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'
        '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.edit
components:
  schemas:
    DataSource:
      type: object
      properties:
        id:
          type: string
          description: Data source id.
          examples:
          - ds_6f7a8b9c0d1e2f3a
        spaceId:
          type: string
        name:
          type: string
        type:
          type: string
          description: Connector type (`csv`, `http-json`, `rest`, `google-sheets`, `ical`, …). See `GET /v1/connectors`.
        config:
          description: Connector settings with every credential-shaped value (keys, tokens, secrets, passwords) replaced by `••••••••`. Send the mask back unchanged to keep the stored value.
        cachedData:
          anyOf:
          - {}
          - type: 'null'
          description: The last successful fetch (JSON), or null before the first sync.
        connected:
          type: boolean
          description: The last sync succeeded.
        lastSyncedAt:
          anyOf:
          - type: string
            description: ISO-8601 timestamp (UTC).
          - type: 'null'
        syncError:
          anyOf:
          - type: string
          - type: 'null'
          description: Why the last sync failed; null when it succeeded.
        nodeId:
          anyOf:
          - type: string
          - type: 'null'
        createdAt:
          type: string
          description: ISO-8601 timestamp (UTC).
        updatedAt:
          type: string
          description: ISO-8601 timestamp (UTC).
      required:
      - id
      - spaceId
      - name
      - type
      - config
      - cachedData
      - connected
      - lastSyncedAt
      - syncError
      - nodeId
      - createdAt
      - updatedAt
      description: A connected data feed. Credentials are never returned.
    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.