Child pages
  • WHM API 1 Functions - modsec_get_config_text

Versions Compared

Key

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

Description

Excerpt

This function retrieves a ModSecurity™ configuration file's contents.

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_get_config_text?api.version=1&config=modsec2.example.conf



Expand
titleXML API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/modsec_get_config_text?api.version=1&config=modsec2.example.conf



Expand
titleCommand Line


Code Block
languagebash
whmapi1 modsec_get_config_text config=modsec2.example.conf

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
    "data": {
        "text": "SecRule%20REQUEST_URI%20"example"%20"deny%2Cid%3A123456789"%0ASecAction%20"pass%2Cauditlog%2Cid%3A444444444"n"
    },
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": 1,
        "command": "modsec_get_config_text"
    }
}



Expand
titleOutput (XML)


Code Block
languagetext
linenumberstrue
<result>
   <data>
      <text>SecRule REQUEST_URI "example" "deny:id:123456789"
SecAction "pass:auditlog:id:444444444"</text>
   </data>
   <metadata>
      <version>1</version>
      <reason>OK</reason>
      <result>1</result>
      <command>modsec_get_config_text</command>
   </metadata>
</result>


Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
configstring

Required

The ModSecurity™ configuration file's name.

A valid filename.modsec2.example.conf

Returns

ReturnTypeDescriptionPossible valuesExample
textstringThe ModSecurity™ configuration file's contents.A valid string.


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