Control Panel — API Documentation



Retrieve the upload status of a Youtube Upload request. Successful uploads will include the Youtube ID of the video

Example Code (PHP)

    $request = array(
        'command' => 'youtube.status',
        'api_key' => 'APX4GKLM0RKQLSP2FBO1ROPKSSW47DZE',
        'timestamp' => time(),
        'cdn' => 158,
        'id' => 1,
        //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
id [REQUIRED] [int] - Unique ID of the youtube upload request. This ID is returned in the response data after making "youtube.upload" request.

Example Result (JSON)

    "message": "Found Youtube Status",
    "status": "success",
    "data": {
            "id" : 1,
            "cdn_id": 158,
            "path": "sestore{#}/jb/path/to/file.mp4",
            "title": "My Video",
            "description: "this is my first upload",
            "tags": "csv,string,of,tags",
            "visibility": "private",
            "callback": "",
            "youtube_id": "12345ABCdef",
            "message": "Successfully Uploaded to Youtube",
            "results": {
                "etag": "...",
                "id": "12345ABCdef",
            "created": "2018-01-01 00:00:00",
            "last_updated": "2018-01-01 1:00:00",
            "status": 200

Result Fields

message [string] - Debugging message
status [string] - "success" or "failure"
handle_time [float] - The amount of time spent processing your request
data [Array]
id [int] - The Youtube upload request ID
cdn_id [int] - The ScaleEngine CDN ID of your account
path [String] - The video filename including filepath to be uploaded.
title [String] - Title for the Youtube video
description [String] - Description for the Youtube video
tags [String] - Comma Separated list of tags for the Youtube video
visibility [String] - Sets the visibility of the video when upload is finished. "private" or "public"
callback [String] - Callback URL to send information when upload is finished
youtube_id [String] - Youtube Video ID
message [String] - Status message
results [Array] - Youtube response data containing etag id, youtube video id, and kind of request made
created [String] - Date and Time the upload request was queued
last_updated [String] - Date and Time the status was last updated
status [int] - http status code