Skip to content

API for LIVE resource

Description

This section describes API methods for creating, deleting and configurations changing of your resources.

All the responses (including errors) return in JSON Format.

Attention!

  1. You can make not more than 20 API requests (POST, PUT, PATCH) every minute. When the limit is reached, a response with the status code 200 will be received:
    {"status": "error", "message": "Rate limit exceeded", "description": "Request is forbidden"}
    
  2. There is a limit of 100 resources. If you need more resources, please contact your personal manager or support.

Find below examples for monitoring and configuring of the options in connection with Live streaming service.

RTMP/RTSP-publish and SRT-publish

API description

To receive the full publication links, you have to combine live resource parameters, received via GET-request.

RTMP/RTSP-publish:

<pub_protocol>://<primary|backup>/<application>/<stream_name>?auth=<password>

SRT-publish:

<pub_protocol>://<primary|backup>:19998/?streamid=#!::r=<application>/<stream_name>,auth=<password>

Examples of links for publication:

rtmp://a.r.cdnvideo.net/livemaster/someid1_stream01?auth=MkE5MGtjbPljT52t491y6z14C
srt://a.r.cdnvideo.net:19998/?streamid=#!::r=livemastersrt/someid1_stream01,auth=IEVM5Vyew2nEjPcYZmaskikMN

<dist_protocol>://<domain>/<application>/<master_stream>/playlist.m3u8

Example of link for stream distribution:

https://p0q2zwj4yih.a.trbcdn.net/livemaster/jws2w_test_resource.smil/playlist.m3u8

HLS-pull

API description

To receive the full streaming links, you have to combine live resource parameters, received via GET-request, and path to stream playlist.

<dist_protocol>://<cdn_domain|names>/<playlist_path>

Example of CDN-links:

https://wtx3l7rtrl6.a.trbcdn.net/stream/playlist.m3u8
https://test.cname.com/stream/playlist.m3u8

Get stream information

General information

This API provides an interface to get information about streams.

The API allows to get information about the status of the stream and the time when the stream appears on the server.

Warning!

There is a limit on the number of API calls: no more than 10 requests per minute.

API description