Child pages
  • cPanel API 1 Functions - Stats::showbandwidth
Skip to end of metadata
Go to start of metadata

Description

This function displays bandwidth usage for the cPanel account's domains. This function will include pie charts with its output.

Warning:

cPanel API 1 is deprecated. We strongly recommend that you do not use cPanel API 1. However, no equivalent function exists in our newer APIs.

Examples 


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$show_bandwidth = $cpanel->api1('Stats','showbandwidth'); // Call the function.


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.
my $show_bandwidth = $cpliveapi->api1('Stats','showbandwidth'); # Call the function.


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 provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Stats::showbandwidth()">
 Command Line
cpapi1 --user=username Stats showbandwidth


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (HTML)
The output contains HTML that indicates the bandwidth usage.

Parameters

This function does not accept parameters.

Returns

This function displays HTML that contains the bandwidth usage.