Child pages
  • WHM API 1 Functions - modsec_edit_rule

Versions Compared

Key

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

Description

Excerpt

This function stages edits to a ModSecurity™ rule.

 The system does not save changes directly to the configuration file. Instead, it stages the changes to the configuration file's .STAGE file (for example, for the example.conf file, the system stages changes in the example.conf.STAGE file).

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_edit_rule?api.version=1&config=modsec_vendor_configs%2Fexample.conf%20&id=1234567&rule=SecAction%20%22pass%2Cid%3A1234567%22



Expand
titleXML API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/modsec_edit_rule?api.version=1&config=modsec_vendor_configs%2Fexample.conf%20&id=1234567&rule=SecAction%20%22pass%2Cid%3A1234567%22



Expand
titleCommand Line


Code Block
languagebash
whmapi1 modsec_edit_rule config=modsec_vendor_configs%5C%2Fexample.conf id=1234567 rule=SecAction'"\pass,id:1234567\"'

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
    "data": {
        "rule": {
            "disabled": 0,
            "rule": "SecAction "pass,id:1234567"",
            "id": "1234567",
            "meta_msg": ""
        }
    },
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": 1,
        "command": "modsec_edit_rule"
    }
}



Expand
titleOutput (XML)


Code Block
languagetext
linenumberstrue
<result>
  <data>
    <rule>
      <disabled>0</disabled>
      <rule>SecAction "pass,id:1234567"</rule>
      <id>1234567</id>
      <meta_msg/>
    </rule>
  </data>
  <metadata>
    <version>1</version>
    <reason>OK</reason>
    <result>1</result>
    <command>modsec_edit_rule</command>
  </metadata>
</result>


Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
configstring

Required

The ModSecurity configuration file.

The path to a valid ModSecurity configuration file, relative to the /usr/local/apache/conf/ directory.
modsec_vendor_configs/example.conf
idinteger

Required

The ModSecurity rule's ID.

A positive integer.
1234567
rulestring

Required

The new rule.

A valid ModSecurity rule.

 


Expand
titleClick to view...
SecAction "pass,id:1234567"


Returns

ReturnTypeDescriptionPossible valuesExample
rulehashA hash of information about the new ModSecurity rule.This hash includes the id, rule, disabled, and meta_msg returns. 

id

integer

The ModSecurity rule's ID.

The function returns this value in the rule hash.

 A valid ModSecurity rule ID.
1234567

rule

string

The ModSecurity rule's text.

The function returns this value in the rule hash.

 A valid ModSecurity rule.


Expand
titleClick to view...
SecAction "pass,id:1234567"


disabled

Boolean

Whether the rule is disabled.

The function returns this value in the rule hash.

  • 1 — Disabled.
  • 0 — Enabled.
0