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

Description

This function deploys staged changes to the ModSecurity™ configuration file and restarts Apache.

Note:

If the new configuration is invalid, the system will restore the original configuration and maintain the staged changes.

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_deploy_rule_changes?api.version=1&config=modsec_vendor_configs%2Fexample.conf
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/modsec_deploy_rule_changes?api.version=1&config=modsec_vendor_configs%2Fexample.conf
 Command Line
whmapi1 modsec_deploy_rule_changes config=modsec_vendor_configs%5C%2Fexample.conf


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_deploy_rule_changes"
    }
}
 Output (XML)
<result>
  <data></data>
  <metadata>
    <command>modsec_deploy_rule_changes</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 name.

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

Returns

This function only returns metadata.