cPanel API 2 Functions - DiskUsage::clearcache - Knowledgebase

Description

This function clears the account's cache of disk space usage data. It is useful if you add or remove a lot of data, and need to rebuild the 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=clearcache

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Clear the disk cache.

$clear_cache = $cpanel->api2(

'DiskUsage', 'clearcache'

);

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Clear the disk cache.

my $clear_cache = $cpliveapi->api2(

'DiskUsage', 'clearcache',

);

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 clearcache

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "clearcache",
    "data": [
      {
        "statusmsg": "cache cleared",
        "status": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "DiskUsage"
  }
}

Note:

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

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
status	Boolean	Whether the disk cache is now cleared.	1 — Disk cache cleared. 0 — Disk cache is clearing.	1
statusmsg	string	Whether the disk cache has cleared.	cache cleared	cache cleared
reason	string	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.
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories