Description
This function displays a domain's bandwidth usage for the current month.
Examples
WHM API (JSON)
https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Stats&cpanel_jsonapi_func=getthismonthsbwdata
LiveAPI PHP Class
$cpanel = new CPANEL();
$get_current_bandwidth = $cpanel->api2(
'Stats', 'getthismonthsbwusage'
)
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $get_current_bandwidth = $cpliveapi->api2(
'Stats', 'getthismonthsbwusage',
);
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 ourDeprecated 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 Stats getthismonthsbwusage
|
Output (JSON)
{
"cpanelresult": {
"apiversion": 2,
"func": "getmonthlydomainbandwidth",
"data": [
{
"bw": {
"example.com": 672
},
],
"event": {
"result": 1
},
"module": "Stats"
}
}
Parameters
This function does not accept parameters.
Returns
|
Return
|
Type
|
Description
|
Possible values
|
Example
|
|
bw
|
hash
|
The domain and the current month's bandwidth usage, in bytes.
|
The domain, a colon (:), and a positive integer.
|
example.com: 672
|
|
reason
|
string
|
A reason for failure.
Note:
This function only returns a reason value if there was an error.
|
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
|
