cPanel API 2 Functions - SourceIPCheck::listips - Knowledgebase

Description

This function lists the account's trusted IP addresses.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=SourceIPCheck&cpanel_jsonapi_func=listips&account=example.com

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// List IP addresses for example.com.
$list_ips = $cpanel->api2(
    'SourceIPCheck', 'listips',
        array(       
            'account'      => 'example.com'
    )
 );

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# List IP addresses for example.com.
my $list_ips = $cpliveapi->api2(
    'SourceIPCheck', 'listips',
    {
        'account'      => '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 theLiveAPI 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 ourDeprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listips",
    "data": [
      {
        "ip": "192.168.0.20"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "SourceIPCheck"
  }
}

Note:

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

Parameters

Input	Type	Description	Possible values	Example
account	string	The cPanel account.	Any valid cPanel account.	example.com

Returns

Return	Type	Description	Possible values	Example
ip	string	The account's IP address(es).	A comma-separated list of IP addresses.	192.168.0.20
reason	string	A reason for failure. Note: This function only returns a reason value if there was an error.	A string that describes the error.	This is an error message.
result	boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories