Guide to cPanel API 1

In cPanel & WHM version 76, we introduced server profiles and roles. When you enable a non-Standard Node server profile, the system disables API calls associated with that profile's disabled roles.

Note:

You cannot call this API's functions via another API's call methods. For more information, read the API method distinctions section below.

Basic usage

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$your_variable = $cpanel->api1('Module', 'function', array('parameter', 'parameter', 'parameter') ); // Call the function.

Note:

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

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $your_variable = $cpliveapi->api1('Module', 'function', ['parameter', 'parameter', 'parameter'] ); # Call the function.

Note:

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

Note:

Currently, individual function documentation does not include Template Toolkit examples.

[%- 
USE Api1;
SET myvariable = execute( 
     'Module', 'function',
    {
        'parameter'      => 'value', 
        'parameter'      => 'value', 
        'parameter'      => 'value', 
    }
);
%]

Note:

For more information, read our Guide to Template Toolkit documentation.

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Module::function( $FORM('parameter','parameter','parameter') )">

cpapi1 --user=username --output=type Module function parameter=value parameter=value

Note:

cPanel & WHM introduced the command line feature in version 56.

cPanel API 1 calls through the command line consist of the following basic parts:

Part	Description
Command	This value is always `cpapi1` for calls to cPanel API 1. Note: If you run CloudLinux™, you must use the full path of the `cpapi`1 command: /usr/local/cpanel/bin/cpapi1
Output Type	The API output type that you wish to receive. Use `--output=json` to return JSON-formatted output. Use `--output=jsonpretty` to return indented JSON-formatted output. Use `--output=xml` to return XML-formatted output. Important: cPanel & WHM version 66 deprecated XML output. Use `--output=yaml` to return YAML-formatted output. Note: This parameter defaults to `--output=yaml`.
Module	The cPanel API 1 module name.
Function	The cPanel API 1 function.
User	The cPanel account-level username.
Input parameters and values	The function's input parameters and their values. You must URI-encode values. Separate multiple `parameter=value` pairs with a space character. Special characters within a key's value may cause an error. You must either escape any special characters within values or surround the value with appropriate quotes. For more information, read Wikipedia's Escape Characters article. For example, a bash shell command with a JSON-encoded value may appear similar to one of the following: `cpapi1 --user username Module function key=[\"sslinstall\",\"videotut\"]"` `cpapi1 --user username Module function key='{"videotut","sslinstall"}'` Note: The term "Boolean" in our documentation refers to parameters that accept values of `1` or `0`. cPanel & WHM's APIs do not support the literal values of `true` and `false`.

Note:

For more information about this feature, run the following command:

cpapi1 --help

These examples use the following variables:

Variable	Description	Example
`Module`	The module for the function that you wish to use.	`Email`
`function`	The cPanel API 1 function that you wish to use.	`addpop`
`parameter`	Input parameters that you pass to the function. Important: cPanel API 1 functions use ordered parameters. You must specify parameters in the order in which they appear in this documentation. cPanel API 1 parameters are case-sensitive. Note: The term "Boolean" in our documentation refers to parameters that accept values of `1` or `0`. cPanel & WHM's APIs do not support the literal values of `true` and `false`.	`example.com`

Warning:

Do not attempt to use cPanel or WHM interface URLs to perform actions in custom code. You must call the appropriate API functions in order to perform the actions of cPanel & WHM's interfaces.

For example, do not pass values to .html pages, as in the following example:

http://example.com:2082/frontend/x3/mail/doaddpop.html/email=name&domain=user.com

While this unsupported method sometimes worked in previous versions of cPanel & WHM, we strongly discourage its use and do not guarantee that it will work in the future. Instead, the correct method to perform this action is to call the appropriate API function.

Call cPanel API 1 from the WHM API

Warning:

Unless you call this API via the WHM API, you cannot call this API via WHM's ports (2086 or 2087).

You can use the WHM API to call cPanel API functions. For more information, read our Use WHM API to Call cPanel API & UAPI documentation.

Important:

Because some cPanel API 1 functions return HTML output, this method will cause parsing errors in most XML parsers. We strongly recommend that you use cPanel API 2 instead.

Custom Event Handlers and Standardized Hooks

You can use the Standardized Hook System to customize the events before and after a cPanel API call.

API method distinctions

cPanel, Inc. produces four current and two deprecated APIs, and they all include separate sets of functions. Make certain that the function and module that you call exist in the API version that your code uses.

Important:

API calls must use the correct port:

2082 — Unsecure calls to cPanel's APIs.
2083 — Secure calls to cPanel's APIs.
2095 — Unsecure calls to cPanel's APIs via a Webmail session.
2096 — Secure calls to cPanel's APIs via a Webmail session.
2086 — Unsecure calls to WHM's APIs, or to cPanel's APIs via the WHM API.
2087 — Secure calls to WHM's APIs, or to cPanel's APIs via the WHM API.

Otherwise-correct calls will return Permission denied or Function not found errors if they use an incorrect port number.

Select a tab to view examples of calls to the desired API:

Browser-based call...

https://hostname.example.com:2087/cpsess##########/json-api/accountsummary?api.version=1&user=username

Note:

Browser-based calls to WHM API 1 must include the WHM API version (api.version=1). If you omit the version, the system calls WHM API 0, which may not contain the desired function, or may contain an older version of that function.

Command-line call...

whmapi1 accountsummary user=username

For more information, read our Guide to Testing Custom Code - WHM API Calls and Guide to WHM API 1 documentation.

cPanel or Webmail session URL call...

https://hostname.example.com:2083/cpsess##########/execute/Module/function?parameter=value&parameter=value&parameter=value

Command-line call...

uapi  --user=username --output=type Module function parameter=value parameter=value

LiveAPI PHP Class call...

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Call a UAPI function.
$function_result = $cpanel->uapi(
    'Module', 'function',
    array(
        'parameter'     => 'value',
        'parameter'     => 'value',
        'parameter'     => 'value',
         )
);

LiveAPI Perl Module call...

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Call a UAPI function.
my $function_result = $cpliveapi->uapi(
    'Module', 'function',
    {
        'parameter'     => 'value',
        'parameter'     => 'value',
        'parameter'     => 'value',
    }
);

Template Toolkit call...

<!-- Call a UAPI function. -->
[% 
execute( 
     'Module', 'function', 
     { 
        'parameter' => 'value', 
        'parameter' => 'value', 
        'parameter' => 'value', 
     } 
); 
%]

Note:

For more information, read our Guide to Testing Custom Code - cPanel API and UAPI Calls and Guide to UAPI documentation.

Call through the WHM API...

https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Module&cpanel_jsonapi_func=function&parameter="value"

Command-line call...

cpapi2 --user=username --output=type Module function parameter=value parameter=value

Template Toolkit call...

<!-- Call a cPanel API 2 function. -->
[%- 
USE Api2;
SET myvariable = execute( 
     'Module', 'function',
    {
        'parameter'      => 'value',
        'parameter'      => 'value',
        'parameter'      => 'value',
    }
);
%]

LiveAPI PHP Class call...

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
   
// Call the function.
$my_variable = $cpanel->api2(
    'Module', 'function',
    array(
        'parameter'      => 'value', 
        'parameter'      => 'value', 
        'parameter'      => 'value',
    )
 );

LiveAPI Perl Module call...

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Call the function.
my $my_variable = $cpliveapi->api2(
    'Module', 'function',
    {
        'parameter'      => 'value',
        'parameter'      => 'value',
        'parameter'      => 'value',
    }
);

Note:

For more information, read our Guide to Testing Custom Code - cPanel API and UAPI Calls and Guide to cPanel API 2 documentation.

Warning:

WHM API 0 is deprecated. We strongly recommend that you only use the equivalent WHM API 1 functions instead.

Browser-based call...

https://hostname.example.com:2087/cpsess##########/json-api/accountsummary?user=username

Command-line call...

whmapi0 accountsummary user=username

Note:

For more information, read our Guide to Testing Custom Code - WHM API Calls and Guide to WHM API 0 documentation.

Warning:

cPanel API 1 is deprecated. We strongly recommend that you use cPanel API 2 or UAPI instead.

Command-line call...

cpapi1 --user=username --output=type Module function parameter=value parameter=value

LiveAPI PHP Class call...

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$your_variable = $cpanel->api1('Module', 'function', array('parameter', 'parameter', 'parameter') ); // Call the function.

LiveAPI Perl Module call...

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $your_variable = $cpliveapi->api1('Module', 'function', ['parameter', 'parameter', 'parameter'] ); # Call the function.

Template Toolkit call...

<!-- Call a cPanel API 1 function. -->
[%- 
USE Api1;
SET myvariable = execute( 
     'Module', 'function',
    {
        'parameter'      => 'value',
        'parameter'      => 'value',
        'parameter'      => 'value',
    }
);
%]

Note:

For more information, read our Guide to Testing Custom Code - cPanel API and UAPI Calls and Guide to cPanel API 1 documentation.

cPanel API 1 Basics

Available in:

cPanel 11+

Languages:

PHP, Perl

Methods:

GET, POST

Return Formats:

See the desired function for output information.

About cPanel API 1

cPanel API 1 accesses information about cPanel accounts.

Warning:

cPanel API 1 is deprecated. We strongly recommend that you use cPanel API 2 or UAPI instead.

Notes:

These functions may require a feature list. To view the available feature lists on a cPanel server, view WHM's Feature Manager interface.
Unless you call this API via the WHM API, you must use the appropriate cPanel ports ( 2082 or 2083 ). You can also call some functions via cPanel's Webmail ports ( 2095 or 2096 ).

Child pages

Introduction

Basic usage

Call cPanel API 1 from the WHM API

Custom Event Handlers and Standardized Hooks

API method distinctions

cPanel API 1 Basics

About cPanel API 1

Related Documentation