Description
This function rebuilds the account's cache of disk space usage data.
Examples
WHM API (JSON)
https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=DiskUsage&cpanel_jsonapi_func=buildcache
LiveAPI PHP Class
$cpanel = new CPANEL();
$rebuild_cache = $cpanel->api2(
'DiskUsage', 'buildcache'
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $rebuild_cache = $cpliveapi->api2(
'DiskUsage', 'buildcache',
);
cPanel Tag System (deprecated)
Warning:
In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.
cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
Command Line
cpapi2 --user=username DiskUsage buildcache
|
Output (JSON)
{
"cpanelresult": {
"apiversion": 2,
"func": "buildcache",
"data": [
{
"statusmsg": "cache built",
"status": 1
}
],
"event": {
"result": 1
},
"module": "DiskUsage"
}
}
Parameters
This function does not accept parameters.
Returns
|
Return
|
Type
|
Description
|
Possible values
|
Example
|
|
status
|
Boolean
|
Whether the disk cache is now rebuilt.
|
- 1 — Disk cache rebuilt.
- 0 — Disk cache is rebuilding.
|
1
|
|
statusmsg
|
string
|
Whether the disk cache has rebuilt.
|
- cache built
- cache already exists
|
cache built
|
|
reason
|
string
|
A reason for failure.
Note:
This function only returns areasonvalue if it failed.
|
A string that describes the error.
|
This is an error message.
|
|
result
|
Boolean
|
Whether the function succeeded.
|
- 1 — The function succeeded.
- 0 — The function failed.
|
1
|
