Return login security configuration settings

This function returns cPHulk's current settings.

Authorizations:

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  load_cphulk_config

Response samples

Content type
application/json
{
  • "data": {
    • "cphulk_config": {
      • "block_brute_force_with_firewall": 1,
      • "block_excessive_brute_force_with_firewall": 1,
      • "brute_force_period_mins": 5,
      • "brute_force_period_sec": 360,
      • "can_temp_ban_firewall": 1,
      • "command_to_run_on_brute_force": "echo \"BRUTE\"",
      • "command_to_run_on_excessive_brute_force": "echo \"TOO MUCH BRUTE\"",
      • "ip_based_protection": 1,
      • "ip_brute_force_period_mins": 15,
      • "ip_brute_force_period_sec": 300,
      • "is_enabled": 1,
      • "lookback_period_min": 360,
      • "lookback_time": 21600,
      • "mark_as_brute": 30,
      • "max_failures": 30,
      • "max_failures_byip": 5,
      • "notify_on_brute": 1,
      • "notify_on_root_login": 1,
      • "notify_on_root_login_for_known_netblock": 1,
      • "username_based_protection": 1,
      • "username_based_protection_for_root": 1,
      • "username_based_protection_local_origin": 1
      }
    },
  • "metadata": {
    • "command": "load_cphulk_config",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}