Red5 Streams API

openapi: 3.2.0
info:
  title: Red5 Pro Stream Manager 2.0 Streams API
  description: The Red5 Pro Stream Manager 2.0 API orchestrates autoscaling clusters of Red5 Pro streaming nodes across cloud infrastructure. It provides REST endpoints for managing live stream publishing and playback sessions, provisioning stream configurations, monitoring node metrics, and proxying WHIP and WHEP WebRTC connections. The API supports dynamic scaling of streaming capacity and is the primary integration point for building scalable live streaming platforms on Red5 Pro.
  version: '2.0'
  contact:
    name: Red5 Support
    url: https://www.red5.net/contact/
  termsOfService: https://www.red5.net/terms/
servers:
- url: https://{streamManagerDomain}/as/v1
  description: Red5 Pro Stream Manager 2.0
  variables:
    streamManagerDomain:
      default: streammanager.example.com
      description: Domain name of the Stream Manager 2.0 instance
security:
- bearerAuth: []
tags:
- name: Streams
  description: Manage live stream publish and subscribe sessions
paths:
  /streams/stream/{nodeGroupName}/publish/{streamGuid}:
    get:
      operationId: getPublishStreamEndpoint
      summary: Get Publish Stream Endpoint
      description: Returns the connection details for a publisher to connect to the correct Red5 Pro node for broadcasting a stream. The Stream Manager selects an appropriate node based on load and availability within the specified node group.
      tags:
      - Streams
      parameters:
      - $ref: '#/components/parameters/nodeGroupNameParam'
      - $ref: '#/components/parameters/streamGuidParam'
      responses:
        '200':
          description: Publish endpoint information returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StreamEndpoint'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /streams/stream/{nodeGroupName}/subscribe/{streamGuid}:
    get:
      operationId: getSubscribeStreamEndpoint
      summary: Get Subscribe Stream Endpoint
      description: Returns the connection details for a subscriber to connect to the correct Red5 Pro node for consuming a live stream. Routes subscribers to nodes that have the stream available within the specified node group.
      tags:
      - Streams
      parameters:
      - $ref: '#/components/parameters/nodeGroupNameParam'
      - $ref: '#/components/parameters/streamGuidParam'
      responses:
        '200':
          description: Subscribe endpoint information returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StreamEndpoint'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    Error:
      type: object
      description: Error response
      properties:
        code:
          type: integer
          description: HTTP status code
        message:
          type: string
          description: Human-readable error message
    StreamEndpoint:
      type: object
      description: Connection endpoint details for a publisher or subscriber
      properties:
        host:
          type: string
          description: Hostname or IP address of the Red5 Pro streaming node
        port:
          type: integer
          description: Port number for the streaming connection
        protocol:
          type: string
          description: Streaming protocol to use (rtmp, rtsp, wss)
        streamGuid:
          type: string
          description: Stream GUID
        app:
          type: string
          description: Application scope name on the target node
  parameters:
    nodeGroupNameParam:
      name: nodeGroupName
      in: path
      description: Name of the node group (cluster) to target
      required: true
      schema:
        type: string
    streamGuidParam:
      name: streamGuid
      in: path
      description: Unique identifier (GUID) for the stream
      required: true
      schema:
        type: string
  responses:
    NotFound:
      description: The requested resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication failed or bearer token is missing or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT bearer token for authenticating Stream Manager API requests
externalDocs:
  description: Red5 Pro Stream Manager 2.0 API Documentation
  url: https://www.red5.net/docs/red5-pro/development/api/stream-manager-2-0/