- Created by Documentation, last modified on Oct 05, 2018
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
set_user_email_forward_destination
unblock_incoming_email_from_country
unblock_incoming_email_from_domain
Description
This function lists the ModSecurity™ configuration files that have staged changes.
Important:
WebServer
role, the system disables this function. For more information, read our How to Use Server Profiles documentation.Examples
https://hostname.example.com:2087/cpsess##########/json-api/modsec_get_configs_with_changes_pending?api.version=1
https://hostname.example.com:2087/cpsess##########/xml-api/modsec_get_configs_with_changes_pending?api.version=1
whmapi1 modsec_get_configs_with_changes_pending
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 --help
command. If you run CloudLinux™, you must use the full path of the
whmapi1
command:/usr/local/cpanel/bin/whmapi1
{ "data": { "configs": [ "modsec2.user.conf", "modsec_vendor_configs/vendor_test.conf" ] }, "metadata": { "version": 1, "reason": "OK", "result": 1, "command": "modsec_get_configs_with_changes_pending" } }
<result> <data> <configs>modsec2.user.conf</configs> <configs>modsec_vendor_configs/vendor_test.conf</configs> </data> <metadata> <version>1</version> <reason>OK</reason> <result>1</result> <command>modsec_get_configs_with_changes_pending</command> </metadata> </result>
Note:
Parameters
This function does not accept parameters.
Returns
Return | Type | Description | Possible values | Example |
---|---|---|---|---|
configs | array | An array of ModSecurity configuration files. | An array of one or more ModSecurity configuration file names. | modsec2.user.conf |
Function information
API Version:
Available in:
WHM 11.46+
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
root
user. - You must use the appropriate WHM ports (
2086
or2087
) to call WHM API functions.
Find a function
Related functions
-
Page:WHM API 1 Sections - ModSecurity — ModSecurity functions allow you to manage ModSecurity rules and vendors on your server.
-
Page:WHM API 1 Functions - modsec_add_rule — This function adds a new rule to a ModSecurity™ configuration staging file.
-
Page:WHM API 1 Functions - modsec_add_vendor — This function adds a new ModSecurity™ vendor rule set to the server.
-
Page:WHM API 1 Functions - modsec_batch_settings — This function adds, updates, and removes global ModSecurity™ configuration directives.
-
Page:WHM API 1 Functions - modsec_clone_rule — This function copies a ModSecurity™ rule with a new rule ID.