Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function queries a Round Robin Database (RRD) dataset for your account's bandwidth data.

Warning:

We removed this function in cPanel & WHM version 11.52. We strongly recommend that you use the following UAPI function instead of this function:

  • Bandwidth::query — This function queries an account's bandwidth data and returns a report.

Examples 


 WHM API (JSON)
https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Bandwidth&cpanel_jsonapi_func=getbwdata&types=all&dataset=rate&ct=AVERAGE&resolution=63072000

Note:

 For more information, read our Calls from the WHM API documentation.

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Get bandwidth data for example.com.
$add_bandwidth = $cpanel->api2(
    'bandwidth', 'getbwdata',
		array(
		'types'				=> 'all',
		'dataset'		  	=> 'rate',
		'cf'				=> 'AVERAGE',
		'resolution'		=> '63072000',
	)
  );

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.
 
# Get bandwidth data for example.com.
my $get_bandwidth_data = $cpliveapi->api2(
	'Bandwidth', 'getbwdata',
	{
		'types'				=> 'all',
		'dataset'		  	=> 'rate',
		'cf'				=> 'AVERAGE',
		'resolution'		=> '63072000',
 	}	
);

 

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

Important:

Because we removed this function before we introduced this functionality, you cannot call this function via the command line. 

 Output (JSON)
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "getbwdata",
    "data": [
      {
        "ftp": [
          [
            0,
            0
          ],
          [
            3600,
            0
          ],
          [
            7200,
            0
          ],
          [
            10800,
            0
          ],
          [
            14400,
            0
          ],
          [
            18000,
            0
          ],
          [
            21600,
            0
          ],
          [
            25200,
            0
          ],
          [
            28800,
            0
          ],
          [
            32400,
            0
          ],
          [
            36000,
            0
          ],
          [
            39600,
            0
          ],
          [
            43200,
            0
          ],
          [
            46800,
            0
          ],
          [
            50400,
            0
          ],
          [
            54000,
            0
          ],
          [
            57600,
            0
          ],
          [
            61200,
            0
          ],
          [
            64800,
            0
          ],
          [
            68400,
            0
          ],
          [
            72000,
            0
          ],
          [
            75600,
            0
          ],
          [
            79200,
            0
          ],
          [
            82800,
            0
          ]
        ],
        "smtp": [
          [
            0,
            0
          ],
          [
            3600,
            0
          ],
          [
            7200,
            0
          ],
          [
            10800,
            0
          ],
          [
            14400,
            0
          ],
          [
            18000,
            0
          ],
          [
            21600,
            0
          ],
          [
            25200,
            0
          ],
          [
            28800,
            0
          ],
          [
            32400,
            0
          ],
          [
            36000,
            0
          ],
          [
            39600,
            0
          ],
          [
            43200,
            0
          ],
          [
            46800,
            0
          ],
          [
            50400,
            0
          ],
          [
            54000,
            0
          ],
          [
            57600,
            0
          ],
          [
            61200,
            0
          ],
          [
            64800,
            0
          ],
          [
            68400,
            0
          ],
          [
            72000,
            0
          ],
          [
            75600,
            0
          ],
          [
            79200,
            0
          ],
          [
            82800,
            0
          ]
        ],
        "http": [
          [
            0,
            0
          ],
          [
            3600,
            0
          ],
          [
            7200,
            0
          ],
          [
            10800,
            0
          ],
          [
            14400,
            0
          ],
          [
            18000,
            0
          ],
          [
            21600,
            0
          ],
          [
            25200,
            0
          ],
          [
            28800,
            0
          ],
          [
            32400,
            0
          ],
          [
            36000,
            0
          ],
          [
            39600,
            0
          ],
          [
            43200,
            0
          ],
          [
            46800,
            0
          ],
          [
            50400,
            0
          ],
          [
            54000,
            0
          ],
          [
            57600,
            0
          ],
          [
            61200,
            0
          ],
          [
            64800,
            0
          ],
          [
            68400,
            0
          ],
          [
            72000,
            0
          ],
          [
            75600,
            0
          ],
          [
            79200,
            0
          ],
          [
            82800,
            0
          ]
        ],
        "pop3": [
          [
            0,
            0
          ],
          [
            3600,
            0
          ],
          [
            7200,
            0
          ],
          [
            10800,
            0
          ],
          [
            14400,
            0
          ],
          [
            18000,
            0
          ],
          [
            21600,
            0
          ],
          [
            25200,
            0
          ],
          [
            28800,
            0
          ],
          [
            32400,
            0
          ],
          [
            36000,
            0
          ],
          [
            39600,
            0
          ],
          [
            43200,
            0
          ],
          [
            46800,
            0
          ],
          [
            50400,
            0
          ],
          [
            54000,
            0
          ],
          [
            57600,
            0
          ],
          [
            61200,
            0
          ],
          [
            64800,
            0
          ],
          [
            68400,
            0
          ],
          [
            72000,
            0
          ],
          [
            75600,
            0
          ],
          [
            79200,
            0
          ],
          [
            82800,
            0
          ]
        ],
        "imap": [
          [
            0,
            0
          ],
          [
            3600,
            0
          ],
          [
            7200,
            0
          ],
          [
            10800,
            0
          ],
          [
            14400,
            0
          ],
          [
            18000,
            0
          ],
          [
            21600,
            0
          ],
          [
            25200,
            0
          ],
          [
            28800,
            0
          ],
          [
            32400,
            0
          ],
          [
            36000,
            0
          ],
          [
            39600,
            0
          ],
          [
            43200,
            0
          ],
          [
            46800,
            0
          ],
          [
            50400,
            0
          ],
          [
            54000,
            0
          ],
          [
            57600,
            0
          ],
          [
            61200,
            0
          ],
          [
            64800,
            0
          ],
          [
            68400,
            0
          ],
          [
            72000,
            0
          ],
          [
            75600,
            0
          ],
          [
            79200,
            0
          ],
          [
            82800,
            0
          ]
        ],
        "all": [
          [
            0,
            0
          ],
          [
            3600,
            0
          ],
          [
            7200,
            0
          ],
          [
            10800,
            0
          ],
          [
            14400,
            0
          ],
          [
            18000,
            0
          ],
          [
            21600,
            0
          ],
          [
            25200,
            0
          ],
          [
            28800,
            0
          ],
          [
            32400,
            0
          ],
          [
            36000,
            0
          ],
          [
            39600,
            0
          ],
          [
            43200,
            0
          ],
          [
            46800,
            0
          ],
          [
            50400,
            0
          ],
          [
            54000,
            0
          ],
          [
            57600,
            0
          ],
          [
            61200,
            0
          ],
          [
            64800,
            0
          ],
          [
            68400,
            0
          ],
          [
            72000,
            0
          ],
          [
            75600,
            0
          ],
          [
            79200,
            0
          ],
          [
            82800,
            0
          ]
        ]
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Bandwidth"
  }
}

Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
typesstring

Required

The bandwidth type.

  • http
  • ftp
  • smtp
  • pop3
  • imap
  • all
all
datasetstring

Required

The RRD dataset.

This parameter defaults to rate.

  • peak — Up to four years of hourly data.
  • rate — Two days of five-minute resolution data and one month of 30-minute resolution data.
rate
cfstring

The RRD consolidation function.

If you do not specify a value, this parameter defaults to AVERAGE.

  • AVERAGE The average of the available data points.  
  • MIN The smallest of the available data points.
  • MAX — The largest of the available data points.
  • LAST — The last available data points.
AVERAGE
resolutioninteger

The size of the timestamp, in seconds.

If you do not specify a value, this parameter defaults to the current time.

Any positive integer.63072000

Returns

ReturnTypeDescriptionPossible valuesExample
allintegerThe amount of total bandwidth.A positive integer, in bits.50400,0
ftpintegerThe amount of FTP bandwidth.A positive integer, in bits.3600,0
httpintegerThe amount of HTTP bandwidth.A positive integer, in bits.7200,0
imapintegerThe amount of IMAP bandwidth.A positive integer, in bits.10800
pop3integerThe amount of POP3 bandwidth.A positive integer, in bits.14400,0
smtpintegerThe amount of SMTP bandwidth.A positive integer, in bits.18000,0
reasonstring

A message of success of a reason for failure.

 

A string that describes the system's action or the error.This is an error message.
resultBoolean

Whether the function succeeded.

 

  • 1 — The function succeeded.
  • 0 — The function failed.
1