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

Description

This function adds a deny from IP line to the account's .htaccess file.

Warning:

cPanel API 1 is deprecated. We strongly recommend that you do not use cPanel API 1. However, no equivalent function exists in our newer APIs.

Important:

In cPanel & WHM version 76 and later, when you disable the WebServer role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$deny_ip = $cpanel->api1('DenyIp', 'adddenyip', array('192.168.0.1','0') ); // 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 $deny_ip = $cpliveapi->api1('DenyIp', 'adddenyip', ['192.168.0.1','0'] ); # 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::adddenyip( $FORM('ip','quiet') )">
 Command Line
cpapi1 --user=username DenyIp adddenyip 192.168.0.1 0


Notes:

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

    /usr/local/cpanel/bin/cpapi1

 Output (plaintext)
Users from the IP address(s) 192.168.0.1 will not be able to access your site.

Parameters

ParameterTypeDescriptionPossible valuesExample
ip

string

Required

The IP address or addresses to deny.

A single IP address, or a range of addresses as follows:

ExampleDescription

192.168.0.1

Single IP Address

192.168.0.1-192.168.0.58

Range

192.168.0.1-58

Implied Range

192.168.0.1/16

CIDR Format, which matches 192.168.*.*
10.Matches 10.*.*.*

192.168.0.1

 

quietBooleanWhether to suppress error messages.
  • 1 — Hide error messages.
  • 0 — Display error messages.
0

Returns

  • If it succeeded, the function returns a message of success.
  • If it failed, this function returns any errors, unless you set the quiet parameter to 1.