Description

This function lists ModSecurity™ configuration files.

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

Examples 





 https://hostname.example.com:2087/cpsess##########/json-api/modsec_get_configs?api.version=1




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




whmapi1 modsec_get_configs



 {
    "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"
    }
}




 <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>



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.

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



Function information



API Version:


WHM API 1




Available in:


WHM 11.48+




Methods:


GET, POST




Required Parameters:


(none)




Return Formats:


JSON, XML



About WHM API 1

Find a function

Related functions