# cPanel API 2 Functions - DenyIp::listdenyips Warning: The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2. ## Description This function lists blocked IP addresses. Warning: We **strongly** recommend that you use [UAPI](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists. Important: When you disable the [*Web Server* role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function. ## Examples WHM API (JSON) ```undefined syntaxhighlighter-pre 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 ``` Note: For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation. LiveAPI PHP Class ```undefined syntaxhighlighter-pre $cpanel = new CPANEL(); // Connect to cPanel - only do this once. // List the IP addresses that the site blocks. $list_denyip = $cpanel->api2( 'DenyIp', 'listdenyips' ); ``` Note: For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system). LiveAPI Perl Module ```undefined syntaxhighlighter-pre 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', ); ``` Note: For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system). cPanel Tag System (deprecated) Warnings: - cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) system to call the cPanel APIs. Examples are **only** present in order to help developers move from the old cPanel tag system to our [LiveAPI](/guides/guide-to-the-liveapi-system). - cPanel API 2 calls that use cPanel tags vary in code syntax and in their output. - For more information, read our [Deprecated cPanel Tag Usage](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation. Command Line ```undefined syntaxhighlighter-pre cpapi2 --user=username DenyIp listdenyips ``` div Notes: - You **must** URI-encode values. - `username` represents your account-level username. - You **must** include the `--user=username` option. - For more information and additional output options, read our [Guide to cPanel API 2](/cpanel-api-2/) documentation or run the `cpapi2 --help` command. - If you run CloudLinux™, you **must** use the full path of the `cpapi2` command: ```undefined syntaxhighlighter-pre /usr/local/cpanel/bin/cpapi2 ``` br Output (JSON) ```undefined syntaxhighlighter-pre { "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](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls. ## Parameters This function does not accept parameters. ## Returns table thead tr th strong Return th strong Type th strong Description th strong Possible values th strong Example tbody tr td code ip td em string td p The blocked IP address. td A valid IP address, or a CIDR -formatted range of IP addresses in escaped format. td code 10.11.12.13 tr td code range td em em string td p The range of blocked IP addresses. td p Two IP addresses, separated by a hyphen. td code 10.11.12.10-10.11.12.13 tr td code start td em string td The lowest IP address in the blocked range. td A valid IP address. td code 10.11.12.10 tr td code end td em string td The highest IP address in the blocked range. td A valid IP address. td code 10.11.12.13 tr td code reason td em string td p A reason for failure. p This function only returns a code reason value if it failed. td p A string that describes the error. td code This is an error message. tr td code result td em Boolean td p Whether the function succeeded. td ul li code 1 — The function succeeded. li code 0 — The function failed. td code 1