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 RTMP Restreamer API

Configure RTMP and RTMPS push/pull restreaming

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

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

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

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

3 operations 3 paths 6 schemas 3 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 RTMP Restreamer 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 3

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

RTMP Restreamer 3

Configure RTMP and RTMPS push/pull restreaming

POST
/restreamer/provision.create
Create Rtmp Restream Provision
createRtmpProvision 1 param body → 200400401
POST
/restreamer/provision.delete
Delete Rtmp Restream Provision
deleteRtmpProvision 1 param body → 200400401
POST
/restreamer/provision.pull.create
Create Rtmp Pull Restream Provision
createRtmpPullProvision 1 param body → 200400401

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are RtmpPullProvision (4 properties), RtmpDestination (3 properties), ProvisionResponse (3 properties), RtmpProvision (3 properties). Each schema is shown below with its type and property counts.

RtmpPullProvision
object
Configuration for pulling a stream from an external RTMP source
4 properties 2 required
RtmpProvision
object
Configuration for an RTMP push restreaming provision
3 properties 2 required
Error
object
Error response
2 properties
ProvisionResponse
object
Response from a provision create or delete operation
3 properties
ProvisionDelete
object
Parameters to identify the provision to delete
2 properties 1 required
RtmpDestination
object
An external RTMP destination for stream retransmission
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

red5-rtmp-restreamer-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