API for pull resources
General information
This section describes the API methods for creating, deleting, and modifying the configuration of resources related to the live streaming service.
These methods are used when working with the pull
scheme, where the stream is retrieved from an external source.
Please note
Currently, pulling via RTMP, RTSP, SRT and HLS protocols is supported. If you need to use other protocols, please contact your personal manager or support.
All the responses, including errors, return in JSON Format.
Attention!
- 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"}
- 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/SRT-pull
API description
Get links for distribution
To receive the full streaming links, you have to combine live resource parameters, received via GET-request.
<dist_protocol>://<domain>/<application>/<master_stream>/playlist.m3u8
Example of CDN-links:
https://p0q2zwj4yih.a.trbcdn.net/livemaster/jws2w_test_resource.smil/playlist.m3u8
HLS-pull
API description
Get links for distribution
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