file/getdiskusage
Description
Lists file and folder size info about a specified directory in the selected SPanel user account. Subfolders are not included and if needed must be queried separately.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| token | string | Yes | Authorizing API token – check API Basics for more information. |
| accountuser | string | Yes | The SPanel user account that is being managed or viewed. |
| action | string | Yes | The category and function being executed. |
| path | string | No | Default: null (empty). Directory to get info for. It is relative to the SPanel user’s home directory. For example, using an empty string will return the file and folder info for the home directory only while specifying a folder name will return info for its contents only. |
Example
$endpointUrl = 'https://123.123.123.123/spanel/api.php';
$postData = [
'token' => 'provided_auth_token',
'accountuser' => 'spanelio',
'action' => 'file/getdiskusage
',
//'path' => 'public_html'
];
$ch = curl_init();
curl_setopt( $ch, CURLOPT_URL, $endpointUrl);
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt( $ch, CURLOPT_POST, true);
curl_setopt( $ch, CURLOPT_POSTFIELDS, http_build_query($postData));
curl_setopt( $ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt( $ch, CURLOPT_SSL_VERIFYHOST, false);
$jsonOutput = curl_exec( $ch );You can find more information about the Endpoint URL in our API Basics article.
Output
{
"result": "success",
"data": [
{
"item": "public_html",
"type": "Dirs",
"size": {
"display": "4KB",
"rawsize": "4"
},
"usageraw": 12
},
{
"item": "lscache",
"type": "Dirs",
"size": {
"display": "4KB",
"rawsize": "4"
},
"usageraw": 12
},
{
"item": "mail",
"type": "Dirs",
"size": {
"display": "8KB",
"rawsize": "8"
},
"usageraw": 25
},
{
"item": ".bash_logout",
"type": "Files",
"size": {
"display": "4KB",
"rawsize": "4"
},
"usageraw": 12
},
{
"item": ".bashrc",
"type": "Files",
"size": {
"display": "4KB",
"rawsize": "4"
},
"usageraw": 12
},
{
"item": ".bash_profile",
"type": "Files",
"size": {
"display": "4KB",
"rawsize": "4"
},
"usageraw": 12
}
]
}