latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

cPHulk
Management

Return login security list records

This function displays a cPHulk list's records.

get/read_cphulk_records

Query parameters

list_name'black' | 'white' required
Example:white

The cPHulk list's name.

  • black
  • white
skip_enabled_check0 | 1
Example:1

Whether to skip checking if cPHulk runs on the server.

Note:

If cPHulk is disabled, the function returns the following message: cPHulk is disabled on the server.

Response

HTTP Request was successful.

Example response

{
  "data": {
    "ips_in_list": {
      "10.1.4.44": "A helpful comment about the IP address.",
      "DEED::1": "A helpful comment about the IP address."
    },
    "list_name": "white",
    "requester_ip_is_whitelisted": 1,
    "restart_ssh": 1,
    "warning_ip": "The IP address is not on the white list.",
    "warning_ssh": "The system disabled the UseDNS setting for sshd in order to add IP addresses to the whitelist. You must restart sshd to implement the change."
  },
  "metadata": {
    "command": "read_cphulk_records",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}