Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Red5 Proxy API

WHIP, WHEP, and WebSocket proxy endpoints

Red5 Proxy API is one of 17 APIs that Red5 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Proxy. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 2 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 2.0.

Requests are made against a single base URL, http://{host}:5080.

2 operations 2 paths 1 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0
Base URL
http://localhost:5080/api/v1
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Red5 Proxy API declares 1 security scheme for authenticating requests. An API key is passed in the query as accessToken (accessToken). By default, every request must be authenticated.

  • accessToken — API access token for authenticating Brew Mixer API requests

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Proxy 2

WHIP, WHEP, and WebSocket proxy endpoints

POST
/proxy/whip/{nodeGroupName}/{streamGuid}
Whip Publish Endpoint
whipPublish 2 params body → 201400401
POST
/proxy/whep/{nodeGroupName}/{streamGuid}
Whep Subscribe Endpoint
whepSubscribe 2 params body → 201400401

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Error (2 properties). Each schema is shown below with its type and property counts.

Error
object
Error response
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

red5-proxy-api-openapi.yml Raw ↑

Other APIs Red5 publishes across the network.

Red5 Pro Server API
Red5 Pro WebRTC SDK
Red5 Core SDK
Red5 Pro iOS Streaming SDK
Red5 Pro Android Streaming SDK
Red5 Admin API
Red5 Applications API
Red5 File Restreamer API
Red5 Images API
Red5 Inputs API
Red5 Logs API
Red5 Mixers API