cPanel API 2 Functions - DiskCounter::disk_counter - Knowledgebase

Knowledgebase

Description

This function lists files on your server as a nested directory tree.

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=DiskCounter&cpanel_jsonapi_func=disk_counter

LiveAPI PHP Class

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

// List files in a nested directory tree.

$list_files = $cpanel->api2(

'DiskCounter', 'disk_counter'

);

LiveAPI Perl Module

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

# List files in a nested directory tree.

my $list_files = $cpliveapi->api2(

'DiskCounter', 'disk_counter',

);

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 DiskCounter disk_counter

Notes:

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

Knowledgebase

Categories

Categories