openapi: 3.1.0
info:
  title: Red5 Pro Brew Mixer Admin Applications API
  description: The Red5 Pro Brew Mixer API is a REST interface for the Cauldron Media Engine that enables dynamic composition of multiple live video and audio streams into a single mixed output stream. It supports creating and managing mixers, controlling input sources and layout, and producing composite streams for broadcasting. The API provides both v1 and v2 endpoints for mixer lifecycle management and image overlay control, making it useful for virtual events, live production, and multi-participant streaming scenarios.
  version: '2.0'
  contact:
    name: Red5 Support
    url: https://www.red5.net/contact/
  termsOfService: https://www.red5.net/terms/
servers:
- url: http://{host}:5080
  description: Red5 Pro Server with Brew Mixer
  variables:
    host:
      default: localhost
      description: Hostname or IP address of the Red5 Pro server
security:
- accessToken: []
tags:
- name: Applications
  description: Application scope statistics and management
paths:
  /applications:
    get:
      operationId: listApplications
      summary: List Applications
      description: Returns a list of all deployed applications (scopes) on the Red5 Pro server along with their statistics including connected client counts and resource usage.
      tags:
      - Applications
      parameters:
      - $ref: '#/components/parameters/accessTokenParam'
      responses:
        '200':
          description: List of applications returned successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Application'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /applications/{appName}:
    get:
      operationId: getApplication
      summary: Get Application Details
      description: Returns detailed statistics for a specific application scope including connected clients, active streams, and resource consumption metrics.
      tags:
      - Applications
      parameters:
      - $ref: '#/components/parameters/appNameParam'
      - $ref: '#/components/parameters/accessTokenParam'
      responses:
        '200':
          description: Application details returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    NotFound:
      description: The requested resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication failed or access token is missing or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      description: Error response
      properties:
        code:
          type: integer
          description: HTTP status code
        message:
          type: string
          description: Human-readable error message
    Application:
      type: object
      description: An application scope deployed on the Red5 Pro server
      properties:
        name:
          type: string
          description: Application scope name
        clientCount:
          type: integer
          description: Number of currently connected clients
        streamCount:
          type: integer
          description: Number of active streams in this application
        bytesIn:
          type: integer
          description: Total bytes received by this application
        bytesOut:
          type: integer
          description: Total bytes sent by this application
  parameters:
    appNameParam:
      name: appName
      in: path
      description: Name of the Red5 Pro application scope
      required: true
      schema:
        type: string
    accessTokenParam:
      name: accessToken
      in: query
      description: API access token for authentication
      required: true
      schema:
        type: string
  securitySchemes:
    accessToken:
      type: apiKey
      in: query
      name: accessToken
      description: API access token for authenticating Brew Mixer API requests
externalDocs:
  description: Red5 Pro Brew Mixer API Documentation
  url: https://www.red5.net/docs/red5-pro/development/api/mixer/brew-mixer-api/