Red5 Pro Server API

openapi: 3.1.0
info:
  title: Red5 Pro Brew Mixer Admin Server 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: Server
  description: Server health, info, and status endpoints
paths:
  /server:
    get:
      operationId: getServerInfo
      summary: Get Server Information
      description: Returns basic information about the Red5 Pro server including version, uptime, and configuration details.
      tags:
      - Server
      parameters:
      - $ref: '#/components/parameters/accessTokenParam'
      responses:
        '200':
          description: Server information returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerInfo'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /server/ping:
    get:
      operationId: pingServer
      summary: Ping the Server
      description: Performs a health check on the Red5 Pro server. Returns a simple response confirming the server is running and accessible.
      tags:
      - Server
      parameters:
      - $ref: '#/components/parameters/accessTokenParam'
      responses:
        '200':
          description: Server is alive
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PingResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    PingResponse:
      type: object
      description: Response from a server ping health check
      properties:
        result:
          type: boolean
          description: True if the server is alive and responding
        timestamp:
          type: integer
          description: Server timestamp in milliseconds since epoch
    ServerInfo:
      type: object
      description: Information about the Red5 Pro server instance
      properties:
        version:
          type: string
          description: Red5 Pro server version string
        uptime:
          type: integer
          description: Server uptime in milliseconds
        host:
          type: string
          description: Server hostname
        port:
          type: integer
          description: Server port number
    Error:
      type: object
      description: Error response
      properties:
        code:
          type: integer
          description: HTTP status code
        message:
          type: string
          description: Human-readable error message
  responses:
    Unauthorized:
      description: Authentication failed or access token is missing or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    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/