Child pages
  • cPanel API 2 Functions - Bandwidth::addhttpbandwidth

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function adds bandwidth to an account.


Warning
titleWarning:

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
    Excerpt Include
    DD:UAPI Functions - Bandwidth::query
    DD:UAPI Functions - Bandwidth::query
    nopaneltrue

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledWebServerRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleWHM API (JSON)


Code Block
languagetext
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

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$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',
	)
  );

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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',
		}	
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning


Expand
titleCommand Line


Warning
titleImportant:

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



Expand
titleOutput (JSON)


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


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


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