- Created by Documentation, last modified on Mar 27, 2020
disable_authentication_provider
disable_failing_authentication_providers
enable_authentication_provider
get_available_authentication_providers
get_provider_client_configurations
get_provider_configuration_fields
get_provider_display_configurations
get_users_authn_linked_accounts
set_provider_client_configurations
set_provider_display_configurations
twofactorauth_generate_tfa_config
twofactorauth_get_user_configs
cpgreylist_is_server_netblock_trusted
cpgreylist_list_entries_for_common_mail_provider
cpgreylist_load_common_mail_providers_config
cpgreylist_save_common_mail_providers_config
cpgreylist_trust_entries_for_common_mail_provider
cpgreylist_untrust_entries_for_common_mail_provider
create_cpgreylist_trusted_host
delete_cpgreylist_trusted_host
block_incoming_email_from_country
block_incoming_email_from_domain
expunge_messages_for_mailbox_guid
get_unique_recipient_count_per_sender_for_user
get_unique_sender_recipient_count_per_user
get_user_email_forward_destination
list_blocked_incoming_email_countries
list_blocked_incoming_email_domains
normalize_user_email_configuration
set_user_email_forward_destination
terminate_cpuser_mailbox_sessions
unblock_incoming_email_from_country
unblock_incoming_email_from_domain
configurebackgroundprocesskiller
enable_monitor_all_enabled_services
get_appconfig_application_list
get_application_contact_event_importance
get_application_contact_importance
link_server_node_with_api_token
remove_in_progress_exim_config_edit
set_application_contact_event_importance
set_application_contact_importance
add_autossl_user_excluded_domains
enqueue_deferred_ssl_installations
fetch_ssl_certificates_for_fqdns
get_autossl_pending_queue_for_domain
get_autossl_pending_queue_for_user
get_autossl_problems_for_domain
get_autossl_user_excluded_domains
get_best_ssldomain_for_service
install_service_ssl_certificate
remove_autossl_user_excluded_domains
set_autossl_user_excluded_domains
Description
This function returns cPHulk's current settings.
Examples
https://hostname.example.com:2087/cpsess##########/json-api/load_cphulk_config?api.version=1
https://hostname.example.com:2087/cpsess##########/xml-api/load_cphulk_config?api.version=1
whmapi1 load_cphulk_config
Notes:
- Unless otherwise noted, you must URI-encode values.
- For more information and additional output options, read our Guide to WHM API 1 documentation or run the
whmapi1 --helpcommand. If you run CloudLinux™, you must use the full path of the
whmapi1command:/usr/local/cpanel/bin/whmapi1
{
"data": {
"cphulk_config": {
"ip_brute_force_period_mins": 15,
"block_brute_force_with_firewall": 0,
"notify_on_brute": "0",
"ip_based_protection": 1,
"max_failures": 15,
"notify_on_root_login_for_known_netblock": 0,
"mark_as_brute": 30,
"block_excessive_brute_force_with_firewall": 0,
"notify_on_root_login": 0,
"lookback_time": 21600,
"brute_force_period_mins": 5,
"username_based_protection_for_root": 0,
"brute_force_period_sec": 300,
"command_to_run_on_excessive_brute_force": "",
"command_to_run_on_brute_force": "",
"ip_brute_force_period_sec": 900,
"is_enabled": 1,
"lookback_period_min": 360,
"username_based_protection_local_origin": 1,
"username_based_protection": 0,
"max_failures_byip": 5,
"can_temp_ban_firewall": 1
}
},
"metadata": {
"version": 1,
"reason": "OK",
"result": 1,
"command": "load_cphulk_config"
}
}
<result>
<data>
<cphulk_config>
<is_enabled>1</is_enabled>
<ip_brute_force_period_mins>15</ip_brute_force_period_mins>
<max_failures>15</max_failures>
<brute_force_period_sec>300</brute_force_period_sec>
<lookback_period_min>360</lookback_period_min>
<mark_as_brute>30</mark_as_brute>
<ip_brute_force_period_sec>900</ip_brute_force_period_sec>
<lookback_time>21600</lookback_time>
<brute_force_period_mins>5</brute_force_period_mins>
<notify_on_brute>0</notify_on_brute>
<notify_on_root_login>0</notify_on_root_login>
<max_failures_byip>5</max_failures_byip>
</cphulk_config>
</data>
<metadata>
<version>1</version>
<reason>OK</reason>
<result>1</result>
<command>load_cphulk_config</command>
</metadata>
</result>
Note:
Parameters
This function does not accept parameters.
Returns
| Return | Type | Description | Possible values | Example |
|---|---|---|---|---|
cphulk_config | Hash | A hash of cPHulk's current settings. | This hash contains the is_enabled, ip_brute_force_period_mins, ip_brute_force_period_sec, block_brute_force_with_firewall, block_excessive_brute_force_with_firewall, can_temp_ban_firewall, command_to_run_on_brute_force, command_to_run_on_excessive_brute_force, ip_based_protection, brute_force_period_mins, brute_force_period_sec, max_failures, max_failures_byip, mark_as_brute, lookback_period_min, lookback_time, notify_on_brute, notify_on_root_login, notify_on_root_login_for_known_netblock, username_based_protection, username_based_protection_for_root, and username_based_protection_local_origin returns. | |
| Boolean | Whether the cPHulk service is enabled. The function returns this value in the |
| 1 |
| integer | The number of minutes during which cPHulk measures an attacker's login attempts. The function returns this value in the | A valid integer, in minutes. | 15 |
| integer | The number of seconds during which cPHulk measures an attacker's login attempts. The function returns this value in the | A valid integer, in seconds. | 300 |
| Boolean | Whether to use the server's firewall to block brute force attacks. The function returns this value in the |
| 1 |
| Boolean | Whether to use the server's firewall to block excessive brute force attacks. The function returns this value in the |
| 1 |
| Boolean | Whether to add temporary IP bans via the server's firewall. The function returns this value in the |
| 1 |
| string | The command to run when the system detects a brute force attack. The function returns this value in the | A valid BASH command. | echo "BRUTE" |
| string | The command to run when the system detects an excessive brute force attack. The function returns this value in the | A valid BASH command. | echo "TOO MUCH BRUTE" |
| Boolean | Whether cPHulk will track failed login attempts via IP addresses. The function returns this value in the |
| 1 |
| integer | The number of minutes during which cPHulk measures all login attempts to a specific user's account. The function returns this value in the | A valid integer, in minutes. | 5 |
| integer | The number of seconds over which cPHulk measures all login attempts to a specific user's account. The function returns this value in the | A valid integer, in seconds. | 360 |
| integer | The maximum number of failures that cPHulk will allow per account within the defined time range. The function returns this value in the | A valid integer. | 30 |
| integer | The maximum number of failures that cPHulk will allow per account from a specific IP address within the defined time range. The function returns this value in the | A valid integer. | 5 |
| 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. The function returns this value in the | A valid integer. | 30 |
| integer | The number of minutes during which cPHulk counts failed logins against a user. The function returns this value in the | A valid integer. | 360 |
| integer | The number of seconds during which cPHulk counts failed logins against a user. The function returns this value in the | A valid integer. | 21600 |
| Boolean | Whether cPHulk will send a notification when it detects a brute force attack. The function returns this value in the |
| 1 |
| Boolean | Whether cPHulk will send a notification when the The function returns this value in the |
| 1 |
| Boolean | Whether cPHulk will send a notification when the The function returns this value in the |
| 1 |
| Boolean | Whether cPHulk will track failed logins by username. The function returns this value in the |
| 1 |
| Boolean | Whether cPHulk will track the The function returns this value in the |
| 1 |
| Boolean | Whether cPHulk will only track failed logins for requests originating locally. The function returns this value in the |
| 1 |
Function information
API Version:
Available in:
WHM 11.48+
Methods:
GET, POST
Required Parameters:
Return Formats:
About WHM API 1
WHM API 1 performs functions and accesses data in WHM.
Notes:
- Some functions and parameters may require that you authenticate as the
rootuser. - You must use the appropriate WHM ports (
2086or2087) to call WHM API functions.
Find a function
Related functions
-
Page:WHM API 1 Sections - cPHulk — cPHulk functions allow you to manage your cPHulk settings.
-
Page:WHM API 1 Functions - read_cphulk_records — This function displays a cPHulk list's records.
-
Page:WHM API 1 Functions - load_cphulk_config — This function returns cPHulk's current settings.
-
Page:WHM API 1 Functions - cphulk_status — This function returns the status of the cPHulk service.
-
Page:WHM API 1 Functions - get_cphulk_user_brutes — This function lists brute force attack entries from the cPHulk database, ordered by user accounts.