Child pages
  • WHM API 1 Functions - modsec_make_config_active

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

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

This makes the ModSecurity configuration file active.

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledWebServerRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleJSON API


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



Expand
titleXML API


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



Expand
titleCommand Line


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

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
    "data": {},
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": 1,
        "command": "modsec_make_config_active"
    }
}



Expand
titleOutput (XML)


Code Block
languagetext
linenumberstrue
<result>
  <data></data>
  <metadata>
    <command>modsec_make_config_active</command>
    <reason>OK</reason>
    <result>1</result>
    <version>1</version>
  </metadata>
</result>


Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


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.