Description

This function adds bandwidth to an account.


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

Examples 




https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Bandwidth&cpanel_jsonapi_func=addhttpbandwidth&bytes=672&domain=colin.com



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Add HTTP bandwidth for example.com.
$add_bandwidth = $cpanel->api2(
    'bandwidth', 'addhttpbandwidth',
		array(
		'bytes'				=> '672',
		'domain'			=> 'example.com',
	)
  );



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Add HTTP bandwidth for example.com.
my $add_bandwidth = $cpliveapi->api2(
	'Bandwidth', 'addhttpbandwidth',
		{
		'bytes'				=> '672',
		'domain'			=> 'example.com',
		}	
);




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




{
  "cpanelresult": {
    "apiversion": 2,
    "func": "addhttpbandwidth",
    "data": [
      {
        "reason": "Bandwidth added for processing.",
        "result": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Bandwidth"
  }
}



Parameters

ParameterTypeDescriptionPossible valuesExample
bytesinteger

Required

The bandwidth amount.

Any positive integer between 1 and 2^64.672
domainstring

Required

The domain's name.

A valid domain name.example.com

Returns

ReturnTypeDescriptionPossible valuesExample
reasonstring

A message of success of a reason for failure.

 

  • A message of success.
  • An error message.
Bandwidth added for processing.
resultBoolean

Whether the function succeeded.

 

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