We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

Child pages
  • UAPI Functions - BlockIp::add_ip
Skip to end of metadata
Go to start of metadata

Description

This function blocks IP addresses from accessing a cPanel account's domains.

Important:

When you disable the Web Server role, the system disables this function.


Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/BlockIP/add_ip?ip=192.0.2.0



Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
//Add IP addresses to the Deny function in the .htaccess file.
$batch = $cpanel->uapi(
    'BlockIP', 'add_ip',
    array(
        'ip'        => '192.0.2.0',
        )
);


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.
 
# Add IP addresses to the Deny function in the .htaccess file.
my $batch = $cpliveapi->uapi(
    'BlockIP', 'add_ip',
    {
        'ip'        => '192.0.2.0',
    }
);


Note:

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

 Command Line
uapi --user=username BlockIp add_ip ip=192.0.2.0 


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/uapi


 Output (JSON)
{
	"errors": null,
	"metadata": {
		"transformed": 1
	},
	"status": 1,
	"warnings": null,
	"data": ["192.0.2.0"],
	"messages": null
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
ip string

Required

This IP address or IP address range that you wish to block.

  • A valid IP address.
  • A valid IP range.

192.0.2.0

or

192.0.2.0/24  

Returns

ReturnTypeDescriptionPossible valuesExample
data array

An array that contains the blocked IP address or IP range.

  • A valid IP address.
  • A valid IP range.
192.0.2.0