Add IP address to cPanel account's block list

This function blocks IP addresses from accessing the domains on a cPanel account.

Important

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

SecurityBasicAuth

Request

query Parameters

required

string

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

Examples:

CIDR Format IPv4 ip=192.168.0.1/16

CIDR Format IPv6 ip=2001:db8::/32

Add by resolving hostname ip=example.com

Implied Range ip=192.168.0.1-58

IPv4 Range ip=192.168.0.1-192.168.0.58

IPv6 Range ip=2001:db8::1-2001:db8::3

Single IPv4 Address ip=192.0.2.0

Single IPv6 Address ip=2001:db8::1

Subnet Range - Matches 10.*.*.* ip=10.

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/BlockIP/add_ip

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  BlockIP \
  add_ip \
  ip='192.168.0.1/16'

Response samples

application/json

{"apiversion": 3,
"func": "add_ip",
"module": "BlockIP",
"result": {"data": ["1.1.1.1"
],
"errors": null,
"messages": null,
"metadata": {"transformed": 1
},
"status": 1,
"warnings": null
}
}