---
title: "Return login security configuration settings"
method: GET
path: "/load_cphulk_config"
tags: ["cPHulk", "Settings"]
---

# Return login security configuration settings

`GET /load_cphulk_config`

This function returns cPHulk's current settings.

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `cphulk_config` object — An object that contains cPHulk's current settings.
      - `block_brute_force_with_firewall` 0 | 1 — Whether to use the server's firewall to block brute force attacks. * `1` - Block. * `0` - Don't block.
      - `block_excessive_brute_force_with_firewall` 0 | 1 — Whether to use the server's firewall to block excessive brute force attacks. * `1` - Block. * `0` - Don't block.
      - `brute_force_period_mins` integer — The number of minutes during which cPHulk measures all login attempts to a specific user's account.
      - `brute_force_period_sec` integer — The number of seconds over which cPHulk measures all login attempts to a specific user's account.
      - `can_temp_ban_firewall` 0 | 1 — Whether to add temporary IP bans via the server's firewall. * `1` - Add. * `0` - Don't add.
      - `command_to_run_on_brute_force` string — The command to run when the system detects a brute force attack. A valid BASH command.
      - `command_to_run_on_excessive_brute_force` string — The command to run when the system detects an excessive brute force attack. A valid BASH command.
      - `ip_based_protection` 0 | 1 — Whether cPHulk will track failed login attempts via IP addresses. * `1` - Track. * `0` - Don't track.
      - `ip_brute_force_period_mins` integer — The number of minutes during which cPHulk measures an attacker's login attempts.
      - `ip_brute_force_period_sec` integer — The number of seconds during which cPHulk measures an attacker's login attempts.
      - `is_enabled` 0 | 1 — Whether the cPHulk service is enabled. * `1` - Enabled. * `0` - Disabled.
      - `lookback_period_min` integer — The number of minutes during which cPHulk counts failed logins against a user.
      - `lookback_time` integer — The number of seconds during which cPHulk counts failed logins against a user.
      - `mark_as_brute` integer — The maximum number of failures that cPHulk will allow per account from a specific IP address before the system locks out that address for two weeks.
      - `max_failures` integer — The maximum number of failures that cPHulk will allow per account within the defined time range.
      - `max_failures_byip` integer — The maximum number of failures that cPHulk will allow per account from a specific IP address within the defined time range.
      - `notify_on_brute` 0 | 1 — Whether cPHulk will send a notification when it detects a brute force attack. * `1` - Send. * `0` - Do not send.
      - `notify_on_root_login` 0 | 1 — Whether cPHulk will send a notification when the root user successfully logs in from an IP address that is not on the whitelist. * `1` - Send. * `0` - Do not send.
      - `notify_on_root_login_for_known_netblock` 0 | 1 — Whether cPHulk will send a notification when the root user successfully logs in from an IP address in the same netblock. * `1` - Send. * `0` - Do not send.
      - `username_based_protection` 0 | 1 — Whether cPHulk will track failed logins by username. * `1` - Track. * `0` - Don't track.
      - `username_based_protection_for_root` 0 | 1 — Whether cPHulk will track the root user's failed logins. * `1` - Track. * `0` - Don't track.
      - `username_based_protection_local_origin` 0 | 1 — Whether cPHulk will only track failed logins for requests originating locally. * `1` - Track. * `0` - Don't track.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` - Success * `0` - Failed: Check the reason field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)