Remove login security record from list

This function deletes a record or records from cPHulk's whitelist or blacklist.

Authorizations:
query Parameters
ip
required
string <ipv4>

The record's IP address.

Note:

To delete multiple IP addresses, increment the parameter name. For example, ip-1, ip-2, ip-3.

Example: ip=192.168.0.1
list_name
required
string

The cPHulk list's name.

  • white
  • black
Enum: "white" "black"
Example: list_name=white
skip_enabled_check
integer
Default: 0

Whether to skip checking if cPHulk runs on the server.

  • 1 - Don’t check cPHulk’s status.
  • 0 - Check cPHulk’s status.

Note:

If cPHulk is disabled and you check its status, the function returns the following message: cPHulk is disabled on the server.

Enum: 0 1
Example: skip_enabled_check=1

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  delete_cphulk_record \
  list_name='white' \
  ip='192.168.0.1'

Response samples

Content type
application/json
{
  • "data": {
    • "ips_failed": {
      • "192.168.0.1": "This is why, alpha.",
      • "192.168.9.1": "This is why, beta."
      },
    • "ips_removed": [
      • "192.168.0.1"
      ],
    • "list_name": "white",
    • "requester_ip": "192.168.0.1",
    • "requester_ip_is_whitelisted": 1
    },
  • "metadata": {
    • "command": "delete_cphulk_record",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}