- 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 Greylisting's current settings.
Examples
https://hostname.example.com:2087/cpsess##########/json-api/load_cpgreylist_config?api.version=1
https://hostname.example.com:2087/cpsess##########/xml-api/load_cpgreylist_config?api.version=1
whmapi1 load_cpgreylist_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": {
"cpgreylist_config": {
"is_enabled": "1",
"spf_bypass": 1,
"child_timeout_secs": 5,
"record_exp_time_mins": 4320,
"is_exim_enabled": 1,
"initial_block_time_mins": 10,
"purge_interval_mins": 60,
"max_child_procs": 5,
"must_try_time_mins": 240
}
},
"metadata": {
"version": 1,
"reason": "OK",
"result": 1,
"command": "load_cpgreylist_config"
}
}
<result>
<data>
<cpgreylist_config>
<is_enabled>1</is_enabled>
<spf_bypass>1</spf_bypass>
<child_timeout_secs>5</child_timeout_secs>
<record_exp_time_mins>4320</record_exp_time_mins>
<is_exim_enabled>1</is_exim_enabled>
<initial_block_time_mins>10</initial_block_time_mins>
<purge_interval_mins>60</purge_interval_mins>
<max_child_procs>5</max_child_procs>
<must_try_time_mins>240</must_try_time_mins>
</cpgreylist_config>
</data>
<metadata>
<version>1</version>
<reason>OK</reason>
<result>1</result>
<command>load_cpgreylist_config</command>
</metadata>
</result>
Note:
Parameters
This function does not accept parameters.
Returns
Return | Type | Description | Possible values | Example |
|---|---|---|---|---|
cpgreylist_config | hash | A hash of Greylisting settings. | This hash includes the is_enabled, spf_bypass, child_timeout_secs, record_exp_time_mins, is_exim_enabled, initial_block_time_mins, purge_interval_mins, max_child_procs, and must_try_time_mins returns. | |
| Boolean | Whether Greylisting is enabled. The function returns this value in the |
| 1 |
| Boolean | Whether emails with SPF bypass Greylisting. The function returns this value in the |
| 1 |
| integer | The maximum amount of time that Greylisting waits for a child process to time out. The function returns this value in the | A valid integer, in seconds. | 5 |
| integer | The number of minutes before Greylisting deletes the triplet record and treats a re-sent email as a new, unknown triplet. The function returns this value in the | A valid integer, in minutes. The maximum value for this parameter is | 4320 |
| Boolean | Whether Exim is enabled. The function returns this value in the |
| 1 |
| integer | The number of minutes during which Greylisting defers email from an unknown triplet. The function returns this value in the | A valid integer, in minutes. The maximum value for this parameter is | 10 |
| integer | The number of minutes before Greylisting deletes the records in the Greylisting database. The function returns this value in the | A valid integer, in minutes. | 60 |
| integer | The maximum amount of child processes. The function returns this value in the | A valid positive integer. | 5 |
| integer | The number of minutes during which Greylisting accepts a resent email from an unknown triplet. The function returns this value in the | A valid integer, in minutes. The maximum value for this parameter is | 240 |
Function information
API Version:
Available in:
WHM 11.50+
Methods:
GET, POST
Required Parameters:
(none)
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 Functions - cpgreylist_is_server_netblock_trusted — This function returns the Greylisting trusted status of the server's netblock.
-
Page:WHM API 1 Functions - cpgreylist_list_entries_for_common_mail_provider — This function lists Greylisting's IP addresses for the specified mail provider.
-
Page:WHM API 1 Functions - cpgreylist_status — This function returns the status of Greylisting.
-
Page:WHM API 1 Functions - cpgreylist_trust_entries_for_common_mail_provider — This function marks the IP addresses for the specified mail provider as trusted.
-
Page:WHM API 1 Functions - cpgreylist_untrust_entries_for_common_mail_provider — This function marks the IP addresses for the specified mail provider as not trusted.