Control Panel — API Documentation



This API will retrieve a list of all Streams and Usernames that have been created for this account.Optionally, you can limit the results by an application name, or a stream name.

Example Code (PHP)

    $request = array(
        'command' => 'sevu.liststreamusers',
        'api_key' => 'APX4GKLM0RKQLSP2FBO1ROPKSSW47DZE',
        'timestamp' => time(),
        'cdn' => 158,
        'app' => 'demo-origin',                   /* optional */
        'stream' => 'mystream',                 /* optional */
        //Create request signature
    $json_request = json_encode($request);
    $sig = base64_encode(hash_hmac('sha256', $json_request,
        '8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f', true));
    $request['signature'] = $sig;
    $json_request = json_encode($request);
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, ''); // Set the URL
    curl_setopt($ch, CURLOPT_POST, true); // Perform a POST
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // If not set, curl prints output to the browser
    curl_setopt($ch, CURLOPT_HEADER, false); // If set, curl returns headers as part of the data stream
    curl_setopt($ch, CURLOPT_POSTFIELDS, array('json' => $json_request)); //'Json' string or 'PHP' serialized return
    //If your PHP host does not have a proper SSL certificate bundle, you will need to turn off SSL Certificate Verification
    //This is dangerous, and should only be done temporarily until a proper certificate bundle can be installed
    //curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); // Turns off verification of the SSL certificate.
    //curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); // Turns off verification of the SSL certificate.
    $response = curl_exec($ch); //Execute the API Call
    if (!$response) {
        die('Failed to connect to ScaleEngine API');
    //Decode the response as an associative array 
    $arrResponse = json_decode($response, true); 
    if ($arrResponse) {
        //Operation completed successfully
        //TODO Add work here
    } else {
        //Operation failed
        echo 'An error occured processing your request:';

Request Fields

command [REQUIRED] [string] - API command to execute
cdn [REQUIRED] [int] - The ScaleEngine CDN ID of your account
api_key [REQUIRED] [string] - The API key provided as part of your account
timestamp [REQUIRED] [int] - The unix timestamp of your request, used to prevent authenticated API requests from being replayed
app [OPTIONAL] [string] - The ScaleEngine Application name
stream [OPTIONAL] [string] - Stream name that the user was given permission to publish to.

Example Result (JSON)

    "code": 2091,
    "message": "Stream Users Found",
    "status": "success",
    "users": [{
        "app" : "demo-origin",
        "stream" : "mystream",
        "user" : "username_1",
        "origin_url" : "rtmp://",
        "playback_url " : "",
        "ga_key" : ""
    "handle_time":"0.3795 seconds"

Result Fields

code [int] - API Response Code
  • 2090 - Stream Users were not found
  • 2091 - Stream Users Found
message [string] - Debugging message
status [string] - "success" or "failure"
handle_time [float] - The amount of time spent processing your request
users [array] - Array of Stream Users
id [int] - Unique ID of the stream
app [string] - the ScaleEngine Application name
stream [string] - Stream which the user has permission to publish.
user [string] - Name given to the user to publish with.
origin_url [string] - Connection url for the encoder. Note this does not include the stream name.
playback_url [string] - Stream playback url
playback_url [string] - Stream playback url