cPanel API 2 Functions - SourceIPCheck::addip - Knowledgebase

Description

This function adds an IP address to the list of 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=addip&ip=192.168.0.20

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Add IP address to list of trusted IPs for example.com.
$add_ip = $cpanel->api2(
    'SourceIPCheck', 'addip',
        array(       
            'ip'      => '192.168.0.20'
    )
 );

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Add IP address to list of trusted IPs for example.com.
my $add_ip = $cpliveapi->api2(
    'SourceIPCheck', 'addip',
    {
        'ip'      => '192.168.0.20'
 
    }
 );

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": "addip",
    "data": [
      {
        "status": 1,
        "ip": "192.168.0.20",
        "error": "null."
      }
    ],
    "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
ip	string	Required The IP address.	A valid IP address	192.168.0.20

Input

Type

Description

Possible values

Example

string

Required

The IP address.

A valid IP address

192.168.0.20

Returns

Return	Type	Description	Possible values	Example
status	string	Whether the function added the IP address.	1 — Added. 0 — Not added.	1
ip	string	The IP address.	A valid IP address.	192.168.0.20
error	string	Whether the function succeeded.	null — The function succeeded. An error message.	null
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