We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

Child pages
  • WHM API 1 Functions - modsec_disable_rule
Skip to end of metadata
Go to start of metadata

Description

This function disables a ModSecurity™ rule.

Important:

In cPanel & WHM version 76 and later, when you disable the Web Server role, the system disables this function.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/modsec_disable_rule?api.version=1&config=modsec_vendor_configs%2Fexample.conf&id=1234567890
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/modsec_disable_rule?api.version=1&config=modsec_vendor_configs%2Fexample.conf&id=1234567890
 Command Line
whmapi1 modsec_disable_rule config=modsec_vendor_configs/example.conf id=1234567890
 Output (JSON)
{
    "data": {},
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": 1,
        "command": "modsec_disable_rule"
    }
}
 Output (XML)
<result>
  <data></data>
  <metadata>
    <command>modsec_disable_rule</command>
    <reason>OK</reason>
    <result>1</result>
    <version>1</version>
  </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
configstring

Required

A ModSecurity configuration file's path, relative to the /etc/apache2/conf.d directory.

A ModSecurity configuration file.


modsec_vendor_configs/example.conf

idstring

Required

The ModSecurity rule's ID.

A valid ModSecurity rule ID.


1234567890

Returns

This function only returns metadata.