Child pages
  • WHM API 1 Functions - modsec_get_configs
Skip to end of metadata
Go to start of metadata

Description

This function lists ModSecurity™ configuration files. The system stores the configuration files in the /usr/local/apache/conf/modsec_vendor_configs directory.

Important:

In cPanel & WHM version 76 and later, when you disable the WebServer role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 



 JSON API
 https://hostname.example.com:2087/cpsess##########/json-api/modsec_get_configs?api.version=1
 XML API
 https://hostname.example.com:2087/cpsess##########/xml-api/modsec_get_configs?api.version=1
 Command Line
whmapi1 modsec_get_configs


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
 {
    "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"
    }
}
 Output (XML)
 <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>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

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:

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