Child pages
  • cPanel API 2 Functions - Bandwidth::addhttpbandwidth
Skip to end of metadata
Go to start of metadata

Description

This function adds bandwidth to an account.

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.

Important:

In cPanel & WHM version 76 and later, when you disable the WebServer role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

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=addhttpbandwidth&bytes=672&domain=colin.com


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.
 
// Add HTTP bandwidth for example.com.
$add_bandwidth = $cpanel->api2(
    'bandwidth', 'addhttpbandwidth',
		array(
		'bytes'				=> '672',
		'domain'			=> 'example.com',
	)
  );


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.
 
# Add HTTP bandwidth for example.com.
my $add_bandwidth = $cpliveapi->api2(
	'Bandwidth', 'addhttpbandwidth',
		{
		'bytes'				=> '672',
		'domain'			=> 'example.com',
		}	
);


Note:

For more information, read our Guide to the LiveAPI System.

 cPanel Tag System (deprecated)


Warnings:

  • 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. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
  • cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
  • For more information, read our Deprecated cPanel Tag Usage documentation.

 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": "addhttpbandwidth",
    "data": [
      {
        "reason": "Bandwidth added for processing.",
        "result": 1
      }
    ],
    "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
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