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

Description

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

Important:

In cPanel & WHM version 76 and later, when you disable the WebServer role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/modsec_remove_rule?api.version=1&config=modsec_vendor_configs/example.conf&id=1234567890
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/modsec_remove_rule?api.version=1&config=modsec_vendor_configs/example.conf&id=1234567890
 Command Line
whmapi1 modsec_remove_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.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
    "data": {},
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": 1,
        "command": "modsec_remove_rule"
    }
}
 Output (XML)
<result>
  <data></data>
  <metadata>
    <command>modsec_remove_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

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.