Red5 Provision API

openapi: 3.2.0
info:
  title: Red5 Pro Stream Manager 2.0 Provision 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: Provision
  description: Stream provisioning, authentication, and configuration
paths:
  /streams/provision/{nodeGroupName}/{streamGuid}:
    get:
      operationId: getStreamProvision
      summary: Get Stream Provision
      description: Retrieves the provisioning configuration for a specific stream including authentication settings, cloud recording configuration, and transcoding parameters.
      tags:
      - Provision
      parameters:
      - $ref: '#/components/parameters/nodeGroupNameParam'
      - $ref: '#/components/parameters/streamGuidParam'
      responses:
        '200':
          description: Stream provision returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StreamProvision'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    post:
      operationId: createStreamProvision
      summary: Create Stream Provision
      description: Creates a provisioning configuration for a stream, setting up authentication credentials, cloud storage for recordings, transcoding ladder settings, and other stream-level parameters before publishing begins.
      tags:
      - Provision
      parameters:
      - $ref: '#/components/parameters/nodeGroupNameParam'
      - $ref: '#/components/parameters/streamGuidParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StreamProvision'
      responses:
        '201':
          description: Stream provision created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StreamProvision'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
    delete:
      operationId: deleteStreamProvision
      summary: Delete Stream Provision
      description: Removes the provisioning configuration for a stream, clearing authentication settings, cloud recording configuration, and transcoding parameters.
      tags:
      - Provision
      parameters:
      - $ref: '#/components/parameters/nodeGroupNameParam'
      - $ref: '#/components/parameters/streamGuidParam'
      responses:
        '200':
          description: Stream provision deleted successfully
        '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
    StreamProvision:
      type: object
      description: Provisioning configuration for a stream
      properties:
        streamGuid:
          type: string
          description: Unique identifier for the stream
        username:
          type: string
          description: Publisher authentication username
        password:
          type: string
          description: Publisher authentication password
        recording:
          type: boolean
          description: Whether to enable cloud recording for this stream
        transcodeEnabled:
          type: boolean
          description: Whether to enable adaptive bitrate transcoding
        transcodeLadder:
          type: array
          description: List of transcode output variants
          items:
            $ref: '#/components/schemas/TranscodeVariant'
    TranscodeVariant:
      type: object
      description: A single output variant in the transcoding ladder
      properties:
        level:
          type: string
          description: Variant level name (e.g., low, mid, high)
        videoWidth:
          type: integer
          description: Output video width in pixels
        videoHeight:
          type: integer
          description: Output video height in pixels
        videoBitrate:
          type: integer
          description: Output video bitrate in bits per second
        audioBitrate:
          type: integer
          description: Output audio bitrate in bits per second
  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'
    BadRequest:
      description: Request body or parameters are 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/