# Add IP address to cPanel account's block list

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



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

Endpoint: GET /BlockIP/add_ip
Version: 11.134.0.5
Security: BasicAuth

## Query parameters:

  - `ip` (string, required)
    The IP address or IP address range that you wish to block.

## Response 200 fields (application/json):

  - `apiversion` (integer)
    The version of the API.
    Example: 3

  - `func` (string)
    The name of the method called.
    Example: "add_ip"

  - `module` (string)
    The name of the module called.
    Example: "BlockIP"

  - `result` (object)

  - `result.data` (array,null)
    IP addresses that were added, as translated by the system.
    Example: ["1.1.1.1"]

  - `result.errors` (array,null)
    List of errors if the API failed.

  - `result.messages` (array,null)
    List of messages generated by the API.

  - `result.metadata` (object)

  - `result.metadata.transformed` (integer)
    Post-processing may have transformed the data.
    Enum: 1

  - `result.status` (integer)
    - 1 - Success
- 0 - Failed: Check the errors field for more details.
    Enum: 0, 1

  - `result.warnings` (array,null)
    List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.