Description

This function removes a rule from a ModSecurity™ configuration file.

Examples




https://hostname.example.com:2087/cpsess##########/json-api/modsec_remove_rule?api.version=1&config=modsec_vendor_configs/example.conf&id=1234567890




https://hostname.example.com:2087/cpsess##########/xml-api/modsec_remove_rule?api.version=1&config=modsec_vendor_configs/example.conf&id=1234567890




whmapi1 modsec_remove_rule config=modsec_vendor_configs%2Fexample.conf id=1234567890



{
    "data": {},
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": 1,
        "command": "modsec_remove_rule"
    }
}




<result>
  <data></data>
  <metadata>
    <command>modsec_remove_rule</command>
    <reason>OK</reason>
    <result>1</result>
    <version>1</version>
  </metadata>
</result>



Parameters

ParameterTypeDescriptionPossible valuesExample
configstring

Required

The ModSecurity configuration file's path and filename.

A valid path and file, relative to the /usr/local/apache/conf/ directory.modsec_vendor_configs/example.conf
 
idinteger

Required

The rule's ID.

A positive integer.
1234567890

Returns

This function only returns metadata.