Child pages
  • cPanel API 1 Functions - Stats::showbandwidth

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function displays bandwidth usage for the cPanel account's domains.

 This function will include pie charts with its output.

Include Page
LIB:_cPanelAPI1NoEquivalent
LIB:_cPanelAPI1NoEquivalent

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$show_bandwidth = $cpanel->api1('Stats','showbandwidth'); // Call the function.

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $show_bandwidth = $cpliveapi->api1('Stats','showbandwidth'); # Call the function.

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

Code Block
languagetext
<cpanel Module="Stats::showbandwidth()">
Expand
titleCommand Line
Code Block
languagebash
cpapi1 --user=username Stats showbandwidth

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote

Expand
titleOutput (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.