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 Streams API

Live stream enumeration, statistics, and control

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

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

This API exposes 6 operations across 6 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 2.0.

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

6 operations 6 paths 4 schemas 4 GET2 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 Streams 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 6

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

Streams 6

Live stream enumeration, statistics, and control

GET
/applications/{appName}/streams
List Streams in an Application
listStreams 2 params → 200401404
GET
/applications/{appName}/streams/{streamName}
Get Stream Details
getStream 3 params → 200401404
POST
/applications/{appName}/streams/{streamName}/action/startrecord
Start Recording a Stream
startStreamRecording 3 params → 200401404
POST
/applications/{appName}/streams/{streamName}/action/stoprecord
Stop Recording a Stream
stopStreamRecording 3 params → 200401404
GET
/streams/stream/{nodeGroupName}/publish/{streamGuid}
Get Publish Stream Endpoint
getPublishStreamEndpoint 2 params → 200401404
GET
/streams/stream/{nodeGroupName}/subscribe/{streamGuid}
Get Subscribe Stream Endpoint
getSubscribeStreamEndpoint 2 params → 200401404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Stream (13 properties), StreamEndpoint (5 properties), Error (2 properties), ActionResponse (2 properties). Each schema is shown below with its type and property counts.

ActionResponse
object
Response from a stream action request
2 properties
Stream
object
A live stream active on the Red5 Pro server
13 properties
Error
object
Error response
2 properties
StreamEndpoint
object
Connection endpoint details for a publisher or subscriber
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

red5-streams-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