Child pages
  • WHM API 1 Functions - modsec_get_configs

Versions Compared

Key

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

Description

Excerpt

This function lists ModSecurity™ configuration files.

 The system stores the configuration files in the /usr/local/apache/conf/modsec_vendor_configs directory.

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_configs?api.version=1



Expand
titleXML API


Code Block
languagexml
 https://hostname.example.com:2087/cpsess##########/xml-api/modsec_get_configs?api.version=1



Expand
titleCommand Line


Code Block
languagebash
whmapi1 modsec_get_configs

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
 {
    "data": {
        "configs": [
            {
                "active": 0,
                "config": "modsec2.user.conf"
            },
            {
                "vendor_id": "MyVendor",
                "active": 1,
                "config": "modsec_vendor_configs/MyVendor/two.conf"
            },
            {
                "vendor_id": "MyVendor",
                "active": 1,
                "config": "modsec_vendor_configs/MyVendor/one.conf"
            }
        ]
    },
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": 1,
        "command": "modsec_get_configs"
    }
}



Expand
titleOutput (XML)


Code Block
languagetext
linenumberstrue
 <result>
  <data>
    <configs>
      <active>0</active>
      <config>modsec2.user.conf</config>
    </configs>
    <configs>
      <vendor_id>MyVendor</vendor_id>
      <active>1</active>
      <config>modsec_vendor_configs/MyVendor/two.conf</config>
    </configs>
    <configs>
      <vendor_id>MyVendor</vendor_id>
      <active>1</active>
      <config>modsec_vendor_configs/MyVendor/one.conf</config>
    </configs>
  </data>
  <metadata>
    <version>1</version>
    <reason>OK</reason>
    <result>1</result>
    <command>modsec_get_configs</command>
  </metadata>
</result>


Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
configs array of hashesAn array of hashes of information about ModSecurity configuration files.

This array includes the config , vendor_id , and active returns.

 

config

string

The configuration file's location.

The function returns this value in the configs array.

A valid path, relative to the /usr/local/apache/conf directory.

modsec_vendor_configs/MyVendor/one.conf

vendor_id

string

The vendor's unique short name.

The function returns this value in the configs array.

A valid string. MyVendor

active

Boolean

Whether the configuration file is active.

Note
titleNote:

The file is active if an include for the configuration file appears in the modsec2.cpanel.conf file.

The function returns this value in the configs array.

  • 1 — Active.
  • 0 Not active.
1