cPanel API 2 Functions - DenyIp::listdenyips - Knowledgebase

Description

This function lists blocked 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=DenyIp&cpanel_jsonapi_func=listdenyips

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// List the IP addresses that the site blocks.

$list_denyip = $cpanel->api2(

'DenyIp', 'listdenyips'

);

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# List the IP addresses that the site blocks.

my $list_denyip = $cpliveapi->api2(

'DenyIp', 'listdenyips',

);

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

cpapi2 --user=username DenyIp listdenyips

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listdenyips",
    "data": [
      {
        "ip": "10.11.12.13",
        "range": "10.11.12.13",
        "start": "10.11.12.13",
        "end": "10.11.12.13"
      },
      {
        "ip": "123.123.123.1/32",
        "range": "123.123.123.1-123.123.123.1",
        "start": "123.123.123.1",
        "end": "123.123.123.1"
      },
      {
        "ip": "122.122.122.1/32",
        "range": "122.122.122.1-122.122.122.1",
        "start": "122.122.122.1",
        "end": "122.122.122.1"
      },
      {
        "ip": "122.122.122.2/31",
        "range": "122.122.122.2-122.122.122.3",
        "start": "122.122.122.2",
        "end": "122.122.122.3"
      },
      {
        "ip": "122.122.122.4/30",
        "range": "122.122.122.4-122.122.122.7",
        "start": "122.122.122.4",
        "end": "122.122.122.7"
      },
      {
        "ip": "122.122.122.8/29",
        "range": "122.122.122.8-122.122.122.15",
        "start": "122.122.122.8",
        "end": "122.122.122.15"
      },
      {
        "ip": "122.122.122.16/28",
        "range": "122.122.122.16-122.122.122.31",
        "start": "122.122.122.16",
        "end": "122.122.122.31"
      },
      {
        "ip": "122.122.122.32/29",
        "range": "122.122.122.32-122.122.122.39",
        "start": "122.122.122.32",
        "end": "122.122.122.39"
      },
      {
        "ip": "122.122.122.40/32",
        "range": "122.122.122.40-122.122.122.40",
        "start": "122.122.122.40",
        "end": "122.122.122.40"
      },
      {
        "ip": "10.10.10.1/32",
        "range": "10.10.10.1-10.10.10.1",
        "start": "10.10.10.1",
        "end": "10.10.10.1"
      },
      {
        "ip": "10.10.10.2/31",
        "range": "10.10.10.2-10.10.10.3",
        "start": "10.10.10.2",
        "end": "10.10.10.3"
      },
      {
        "ip": "10.10.10.4/30",
        "range": "10.10.10.4-10.10.10.7",
        "start": "10.10.10.4",
        "end": "10.10.10.7"
      },
      {
        "ip": "10.10.10.8/31",
        "range": "10.10.10.8-10.10.10.9",
        "start": "10.10.10.8",
        "end": "10.10.10.9"
      },
      {
        "ip": "10.10.10.10/32",
        "range": "10.10.10.10-10.10.10.10",
        "start": "10.10.10.10",
        "end": "10.10.10.10"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "DenyIp"
  }
}

Note:

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

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
ip	string	The blocked IP address.	A valid IP address, or CIDR-formatted range of IP addresses in escaped format.	10.11.12.13
range	string	The range of blocked IP addresses.	Two IP addresses, separated by a hyphen.	10.11.12.10-10.11.12.13
start	string	The lowest IP address in the blocked range.	A valid IP address.	10.11.12.10
end	string	The highest IP address in the blocked range.	A valid IP address.	10.11.12.13
reason	string	A reason for failure. Note: This function only returns a reason value if it failed.	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