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 Pro Server API

The Red5 Pro Server API is an HTTP-based REST API for gathering server, application, client, and stream statistics from a running Red5 Pro instance. It exposes endpoints for server health checks, application scope statistics, active stream enumeration and control, connection management, and log access. The API uses token-based authentication via the accessToken parameter and is accessible at port 5080 on any Red5 Pro server deployment. Developers can use it to monitor and manage live streaming infrastructure programmatically.

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

Tagged areas include Media, Real-Time, REST, Server Management, and Streaming. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 2 operations across 2 paths, and defines 3 schemas. 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 3 schemas 2 GET

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 Pro Server 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 GET. Each is listed below with its method, path, parameters, and response codes.

Server 2

Server health, info, and status endpoints

GET
/server
Get Server Information
getServerInfo 1 param → 200401
GET
/server/ping
Ping the Server
pingServer 1 param → 200401

Schemas 3

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

PingResponse
object
Response from a server ping health check
2 properties
ServerInfo
object
Information about the Red5 Pro server instance
4 properties
Error
object
Error response
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

red5-server-api-openapi.yml Raw ↑

Other APIs Red5 publishes across the network.

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
Red5 Provision API