Self Help Documentation
< All Topics

file/getdiskusage

PostedFebruary 24, 2022
UpdatedApril 25, 2023

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

FieldTypeRequiredDescription
tokenstringYesAuthorizing API token – check API Basics for more information.
accountuserstringYesThe SPanel user account that is being managed or viewed.
actionstringYesThe category and function being executed.
pathstringNoDefault: 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

PHP
PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
$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

JSON
PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
{
    "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
        }
    ]
}
Table of Contents