openapi: 3.1.0
info:
  title: Red5 Pro Brew Mixer Admin Servlet Configuration 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: Servlet Configuration
  description: Server-level restreamer plugin configuration
paths:
  /restreamer/config:
    get:
      operationId: getRestreamConfig
      summary: Get Restreamer Servlet Configuration
      description: Returns the current server-level configuration for the Restreamer plugin servlet, including connection limits, timeouts, and default settings.
      tags:
      - Servlet Configuration
      parameters:
      - $ref: '#/components/parameters/accessTokenParam'
      responses:
        '200':
          description: Restreamer configuration returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestreamerConfig'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Error:
      type: object
      description: Error response
      properties:
        code:
          type: integer
          description: HTTP status code
        message:
          type: string
          description: Human-readable error message
    RestreamerConfig:
      type: object
      description: Server-level restreamer plugin configuration
      properties:
        maxConnections:
          type: integer
          description: Maximum number of concurrent restream connections allowed
        connectionTimeout:
          type: integer
          description: Connection timeout in milliseconds
        reconnectAttempts:
          type: integer
          description: Number of reconnection attempts on connection loss
        reconnectDelay:
          type: integer
          description: Delay between reconnect attempts in milliseconds
  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/