Description

This function adds an include for a ModSecurity™ configuration file to the modsec2.cpanel.conf file.

This makes the ModSecurity configuration file active.

Examples




https://hostname.example.com:2087/cpsess##########/json-api/modsec_make_config_active?api.version=1&config=modsec_vendor_configs%2Fexample.conf




https://hostname.example.com:2087/cpsess##########/xml-api/modsec_make_config_active?api.version=1&config=modsec_vendor_configs%2Fexample.conf




whmapi1 modsec_make_config_active config=modsec_vendor_configs%5C%2Fexample.conf



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




<result>
  <data></data>
  <metadata>
    <command>modsec_make_config_active</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
 

Returns

This function only returns metadata.