cPanel API 2 Functions - Bandwidth::addhttpbandwidth - Knowledgebase

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.

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

 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',
    )
  );

 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',
        }  
);

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

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
bytes	integer	Required The bandwidth amount.	Any positive integer between 1 and 2^64.	672
domain	string	Required The domain's name.	A valid domain name.	example.com

Parameter

Type

Description

Possible values

Example

bytes

integer

Required

The bandwidth amount.

Any positive integer between 1 and 2^64.

672

domain

string

Required

The domain's name.

A valid domain name.

example.com

Returns

Return	Type	Description	Possible values	Example
reason	string	A message of success of a reason for failure.	A message of success. An error message.	Bandwidth added for processing.
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Return

Type

Description

Possible values

Example

reason

string

A message of success of a reason for failure.

A message of success.
An error message.

Bandwidth added for processing.

result

Boolean

Whether the function succeeded.

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

Knowledgebase

Categories

Categories