PixieBrix

PixieBrix Control Rooms API

The control-rooms API from PixieBrix — 3 operation(s) for control-rooms.

GitHub OpenAPI

Operations 5

GET /api/control-rooms/ #
GET /api/control-rooms/configurations/{id}/ #
PATCH /api/control-rooms/configurations/{id}/ #
DELETE /api/control-rooms/configurations/{id}/ #
POST /api/control-rooms/configurations/ #

Documentation

📖
Documentation
https://docs.pixiebrix.com/developer-api
📖
APIReference
https://app.pixiebrix.com/api/docs/
📖
GettingStarted
https://docs.pixiebrix.com/developer-api/making-an-api-request
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/pixiebrix/refs/heads/main/authentication/pixiebrix-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/pixiebrix/refs/heads/main/rate-limits/pixiebrix-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/pixiebrix/refs/heads/main/openapi/pixiebrix-control-rooms-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/pixiebrix/refs/heads/main/conventions/pixiebrix-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/pixiebrix/refs/heads/main/errors/pixiebrix-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/pixiebrix/refs/heads/main/data-model/pixiebrix-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/pixiebrix-control-rooms-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

pixiebrix-control-rooms-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: PixieBrix Control Rooms API
  version: 1.0.0
  description: PixieBrix admin and package registry API
  contact:
    name: PixieBrix Support
    email: support@pixiebrix.com
servers:
- url: https://app.pixiebrix.com
tags:
- name: control-rooms
paths:
  /api/control-rooms/:
    get:
      operationId: retrieveControlRoom
      description: Look up whether a control room is registered for the given hostname query parameter, returning its id and URL when found, or an empty 204 response when no matching control room exists.
      parameters: []
      responses:
        '200':
          content:
            application/json; version=1.0:
              schema:
                $ref: '#/components/schemas/ControlRoom'
            application/vnd.pixiebrix.api+json; version=1.0:
              schema:
                $ref: '#/components/schemas/ControlRoom'
          description: ''
      tags:
      - control-rooms
  /api/control-rooms/configurations/{id}/:
    get:
      operationId: retrieveControlRoomConfiguration
      description: Return the full configuration for a single control room, including its URL, service account credentials, and linked organization.
      parameters:
      - name: id
        in: path
        required: true
        description: A UUID string identifying this control room.
        schema:
          type: string
      responses:
        '200':
          content:
            application/json; version=1.0:
              schema:
                $ref: '#/components/schemas/ControlRoomConfiguration'
            application/vnd.pixiebrix.api+json; version=1.0:
              schema:
                $ref: '#/components/schemas/ControlRoomConfiguration'
          description: ''
      tags:
      - control-rooms
    patch:
      operationId: partialUpdateControlRoomConfiguration
      description: Update fields on an existing control room configuration, re-linking it to the control room when the URL changes.
      parameters:
      - name: id
        in: path
        required: true
        description: A UUID string identifying this control room.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ControlRoomConfiguration'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ControlRoomConfiguration'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ControlRoomConfiguration'
      responses:
        '200':
          content:
            application/json; version=1.0:
              schema:
                $ref: '#/components/schemas/ControlRoomConfiguration'
            application/vnd.pixiebrix.api+json; version=1.0:
              schema:
                $ref: '#/components/schemas/ControlRoomConfiguration'
          description: ''
      tags:
      - control-rooms
    delete:
      operationId: destroyControlRoomConfiguration
      description: Delete a control room configuration.
      parameters:
      - name: id
        in: path
        required: true
        description: A UUID string identifying this control room.
        schema:
          type: string
      responses:
        '204':
          description: ''
      tags:
      - control-rooms
  /api/control-rooms/configurations/:
    post:
      operationId: createControlRoomConfiguration
      description: Register a new control room configuration, linking it to an organization and connecting it to the control room at the provided URL.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ControlRoomConfiguration'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ControlRoomConfiguration'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ControlRoomConfiguration'
      responses:
        '201':
          content:
            application/json; version=1.0:
              schema:
                $ref: '#/components/schemas/ControlRoomConfiguration'
            application/vnd.pixiebrix.api+json; version=1.0:
              schema:
                $ref: '#/components/schemas/ControlRoomConfiguration'
          description: ''
      tags:
      - control-rooms
components:
  schemas:
    ControlRoom:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          description: The Control Room URL
          maxLength: 200
          pattern: "^(?:[a-z0-9.+-]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1-9][0-9]?)(?:\\.(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1-9][0-9]?)){3}|\\[[0-9a-f:.]+\\]|([a-z¡-\uFFFF0-9](?:[a-z¡-\uFFFF0-9-]{0,61}[a-z¡-\uFFFF0-9])?(?:\\.(?!-)[a-z¡-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z¡-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::[0-9]{1,5})?(?:[/?#][^\\s]*)?\\z"
      required:
      - url
    ControlRoomConfiguration:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          description: The Control Room URL
          maxLength: 200
          pattern: "^(?:[a-z0-9.+-]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1-9][0-9]?)(?:\\.(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1-9][0-9]?)){3}|\\[[0-9a-f:.]+\\]|([a-z¡-\uFFFF0-9](?:[a-z¡-\uFFFF0-9-]{0,61}[a-z¡-\uFFFF0-9])?(?:\\.(?!-)[a-z¡-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z¡-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::[0-9]{1,5})?(?:[/?#][^\\s]*)?\\z"
        service_account_username:
          type: string
          maxLength: 255
        service_account_key:
          type: string
        organization:
          type: string
      required:
      - url
      - service_account_username
      - service_account_key
      - organization