Child pages
  • WHM API 1 Functions - modsec_set_config_text

Versions Compared

Key

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

 

Description

Excerpt

This function sets the contents of a specified ModSecurity™ configuration file.

 The system will stage any changes to the configuration file. To deploy the changes, call WHM API 1's modsec_deploy_rule_changes function.

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleJSON API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/modsec_set_config_text?api.version=1&config=modsec2.example.conf&text=SecRule%2520REQUEST_URI%2520"example"%2520"deny%252Cid%253A123456789"%250ASecAction%2520"pass%252Cauditlog%252Cid%253
Expand
titleXML API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/modsec_set_config_text?api.version=1&config=modsec2.example.conf&text=SecRule%2520REQUEST_URI%2520"example"%2520"deny%252Cid%253A123456789"%250ASecAction%2520"pass%252Cauditlog%252Cid%253
Expand
titleCommand Line
Code Block
languagebash
whmapi1 modsec_set_config_text config=modsec2.example.conf text=SecRule%20REQUEST_URI%20\"example\"%20\"deny%2Cid%3A123456789\"%0ASecAction%20\"pass%2Cauditlog%2Cid%3

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
    "data": {},
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": 1,
        "command": "modsec_set_config_text"
    }
}
Expand
titleOutput (XML)
Code Block
languagetext
linenumberstrue
<result>
   <data />
   <metadata>
      <version>1</version>
      <reason>OK</reason>
      <result>1</result>
      <command>modsec_set_config_text</command>
   </metadata>
</result>

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote

Parameters

ParameterTypeDescriptionPossible valuesExample
configstring

Required

The configuration file name.

A valid filename.
modsec2.example.conf
textstring

Required

The configuration text.

A valid string.

 

Expand
titleClick to view...
SecRule REQUEST_URI "example" "deny,id:123456789" SecAction "pass,auditlog,id"

Returns

This function only returns metadata.