Red5 Logs API

openapi: 3.1.0
info:
  title: Red5 Pro Brew Mixer Admin Logs 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: Logs
  description: Server log access endpoints
paths:
  /logs:
    get:
      operationId: getServerLogs
      summary: Get Server Logs
      description: Retrieves server log entries from the Red5 Pro server. Supports filtering by log level and date range to narrow results.
      tags:
      - Logs
      parameters:
      - $ref: '#/components/parameters/accessTokenParam'
      - name: level
        in: query
        description: Log level filter (INFO, WARN, ERROR, DEBUG)
        required: false
        schema:
          type: string
          enum:
          - INFO
          - WARN
          - ERROR
          - DEBUG
      - name: limit
        in: query
        description: Maximum number of log entries to return
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 1000
          default: 100
      responses:
        '200':
          description: Log entries returned successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/LogEntry'
        '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
    LogEntry:
      type: object
      description: A single server log entry
      properties:
        timestamp:
          type: string
          format: date-time
          description: Log entry timestamp
        level:
          type: string
          enum:
          - INFO
          - WARN
          - ERROR
          - DEBUG
          description: Log severity level
        logger:
          type: string
          description: Logger class name
        message:
          type: string
          description: Log message text
  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/