Control Panel — API Documentation
files.list
Deprecated: the files.list API will recursively search through the file path provided
and return a list of all the files and folders contained within. By default
only video files will be returned, but this can be changed by setting the
"type" parameter. A maximum of 100 files will be returned
Example Code (PHP)
$request = array(
'command' => 'files.list',
'api_key' => 'APX4GKLM0RKQLSP2FBO1ROPKSSW47DZE',
'timestamp' => time(),
'cdn' => 158,
'path' => 'sestore4/jb',
'type' => 'video' /*optional*/
'offset' => 25 /*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, 'https://api.scaleengine.net/stable/'); // 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
print_r($arrResponse);
} else {
//Operation failed
echo 'An error occured processing your request:';
print_r($response);
}
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 |
path |
[REQUIRED] [string] - The file path to be searched. File paths begin with an sestore{#}.
To find which sestore to use call files.getstorage.
|
type |
[OPTIONAL] [String] - File type to be returned. By default invalid files
and deleted files are not returned in the list,to see those file types use "deleted",
"invalid", or "includeinvalid". (Default video)
- audio - show only audio files
- deleted - show only deleted files
- includeinvalid - show valid and invalid files
- invalid - show only invalid files
- smil - show only smil files
- valid - show only valid files
- video - show only video files
|
offset |
[OPTIONAL] [int] - Number of results to be
skipped when searching. |
Example Result (JSON)
{
"data":[{
"sestore4/jb" : [{
"folder1" : [{
"__files" : {"movie2.mp4"},
"__is_loaded" : -1,
"__offset": 1,
"__file_count": 1,
}],
"__files" : {"movie.mp4"}
}]
}],
"message": "Found Files List Data",
"status": "success",
"handle_time":"0.3795 seconds"
}
Result Fields
data |
[Array] - List of folders and files found
|
[Array] - Name of the folder . The index of
the array will reflect folder. The folder may
contain additional folders, __files array, or
be empty.
|
__files |
[Array] - A String Array of file names. |
__is_loaded |
[int] - 1) all files in the folder have been returned
0 - folder was skipped
-1 - folder partially loaded
|
__offset |
[int] - offset to use when making follow up calls to retrieve the next set of files.
(only set if the folder was partially loaded)
|
__file_count |
[int] - Number of files and folders in the current directory
(only set if the folder was partially loaded)
|
|
message |
[string] - Debugging message |
status |
[string] - "success" or "failure" |
handle_time |
[float] - The amount of time spent processing your request |