Child pages
  • cPanel API 1 Functions - DenyIp::listdenyips
Skip to end of metadata
Go to start of metadata

Description

This function lists blocked IP addresses.

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

Important:

In cPanel & WHM version 76, the WebServer role affects this function.

Examples


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$list_denyip = $cpanel->api1('DenyIp', 'listdenyip') ); // Call the function.


Note:

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

 

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $list_denyip = $cpliveapi->api1('DenyIp', 'listdenyip'); # Call the function.


Note:

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

 

 cPanel Tag System (deprecated)


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="DenyIp::listdenyip( $FORM('match value','method','msgpart','dest') )">
 Command Line
cpapi1 --user=username DenyIp listdenyips


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/api/uapi


 Output (Text)
btw10.10.10.10\n10.10.10.11\n10.10.10.0/24\n


Note:

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

Parameters

This function does not accept parameters.

Returns

A newline-separated list of IP addresses and CIDR-format ranges that the website blocks.