- Created by Documentation, last modified on Apr 09, 2018
Use WHM API to Call cPanel API & UAPI
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
Description
This function enables a ModSecurity™ rule.
Examples
https://hostname.example.com:2087/cpsess##########/json-api/modsec_undisable_rule?api.version=1&config=modsec_vendor_configs%2Fexample.conf&id=1234567890
https://hostname.example.com:2087/cpsess##########/xml-api/modsec_undisable_rule?api.version=1&config=modsec_vendor_configs%2Fexample.conf&id=1234567890
whmapi1 modsec_undisable_rule config=modsec_vendor_configs%2Fexample.conf id=1234567890
Notes:
- 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. - We introduced this functionality in cPanel & WHM version 11.52.0.8.
{ "data": {}, "metadata": { "version": 1, "reason": "OK", "result": 1, "command": "modsec_undisable_rule" } }
<result> <data></data> <metadata> <command>modsec_undisable_rule</command> <reason>OK</reason> <result>1</result> <version>1</version> </metadata> </result>
Note:
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
config | string | Required The ModSecurity configuration file. | The path to a ModSecurity configuration file, relative to the Note: Do not set this value to the | modsec_vendor_configs/example.conf |
id | string | Required The ModSecurity rule's ID. | A valid ModSecurity rule.
| 1234567890 |
Returns
This function only returns metadata.
Function information
API Version:
Available in:
WHM 11.46+
Methods:
GET, POST
Required Parameters:
config
, id
Return Formats:
About WHM API 1
WHM API 1 performs functions and accesses data in WHM.
Notes:
- Some functions and parameters may require that the 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 Functions - modsec_get_vendors — The function returns a list of configured ModSecurity™ vendors.
-
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_preview_vendor — This function returns the metadata for a ModSecurity™ vendor rule set.
-
Page:WHM API 1 Functions - modsec_enable_vendor_configs — This function enables a ModSecurity™ vendor's configuration files.
-
Page:WHM API 1 Functions - modsec_disable_vendor_configs — This function disables a ModSecurity™ vendor's configuration files.