Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function rebuilds the account's cache of disk space usage data.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

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

Note:

 For more information, read our Calls from the WHM API documentation.

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Rebuild the disk cache.
$rebuild_cache = $cpanel->api2(
    'DiskUsage', 'buildcache'
);

Note:

For more information, read our Guide to the LiveAPI System.

 

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Rebuild the disk cache.
my $rebuild_cache = $cpliveapi->api2(
    'DiskUsage', 'buildcache',
);

Note:

For more information, read our Guide to the LiveAPI System.

 

 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

Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "buildcache",
    "data": [
      {
        "statusmsg": "cache built",
        "status": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "DiskUsage"
  }
}

Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

   

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
statusBooleanWhether the disk cache is now rebuilt.
  • 1 — Disk cache rebuilt.
  • 0 — Disk cache is rebuilding.
1
statusmsgstringWhether the disk cache has rebuilt.
  • cache built
  • cache already exists
cache built
reasonstring

A reason for failure.

Note:

This function only returns a reasonvalue if it failed.

A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1