Control Panel — API Documentation



Retrieves a list of applications for the ScaleEngine account

Example Code (PHP)

    $request = array(
        'command' => 'app.list',
        'api_key' => 'APX4GKLM0RKQLSP2FBO1ROPKSSW47DZE',
        'timestamp' => time(),
        'cdn' => 158,
        //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

Example Result (JSON)

    "message": "Applications found",
    "status": "success",
    "apps" : [
            "id" : 1,
            "cdn_id" : 158,
            "name" : "jb-origin",
            "type" : "origin",
            "origin" : null,
            "backup" : null,
            "playback_hls" : null,
            "playback_rtmp" : null,
            "playback_dash" : null,
            "usage_app_id" : null
    "handle_time":"0.3795 seconds"

Result Fields

apps [Array] - Array of applications
id [int] - Unique Application ID
cdn_id [int] - The ScaleEngine CDN ID of your account
name [string] - Application name
type [string] - Type of application (origin, chorigin, or vod)
origin [string] - origin server for this application if applicable
backup [string] - backup server for this application if applicable
playback_hls [string] - vanity url for HLS playback
playback_rtmp [string] - vanity url for RTMP playback
playback_dash [string] - vanity url for DASH playback
usage_app_id [int] - ID to use when calling the Usage API
message [string] - Debugging message
status [string] - "success" or "failure"
handle_time [float] - The amount of time spent processing your request