Description

This function enables a ModSecurity™ vendor's configuration files.

Examples 




https://hostname.example.com:2087/cpsess##########/json-api/modsec_enable_vendor_configs?api.version=1&vendor_id=SomeVendor




https://hostname.example.com:2087/cpsess##########/xml-api/modsec_enable_vendor_configs?api.version=1&vendor_id=SomeVendor




whmapi1 modsec_enable_vendor_configs vendor_id=SomeVendor



 {
    "data": {
        "outcomes": [
            {
                "active": 1,
                "ok": 1,
                "config": "modsec_vendor_configs/SomeVendor/example.conf"
            }
        ]
    },
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": 1,
        "command": "modsec_enable_vendor_configs"
    }
}




 <result>
  <data>
    <outcomes>
      <active>1</active>
      <config>modsec_vendor_configs/SomeVendor/example.conf</config>
      <ok>1</ok>
    </outcomes>
  </data>
  <metadata>
    <command>modsec_enable_vendor_configs</command>
    <reason>OK</reason>
    <result>1</result>
    <version>1</version>
  </metadata>
</result>



Parameters

ParameterTypeDescriptionPossible valuesExample
vendor_idstring

Required

The vendor's unique short name.

A valid string.
SomeVendor

Returns

ReturnTypeDescriptionPossible valuesExample
outcomesarray of hashesAn array of hashes that contains elements that represent the outcome of each attempt to enable operation.

Each hash includes the active, ok, config, and exception returns.

 

active

Boolean

Whether the configuration file is active.

The function returns this value in the outcomes array.

  • 1 — Active.
  • 0 — Not active.
1

ok

Boolean

Whether the function successfully enabled the configuration file.

The function returns this value in the outcomes array.

  • 1 — Enabled.
  • 0 — Disabled.
1

config

string

The configuration file path.

The function returns this value in the outcomes array.

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


modsec_vendor_configs/SomeVendor/example.conf

 

 

exception

string

If the function fails to enable the configuration file, this return contains the error message.

The function returns this value in the outcomes array.

A valid string.

The function only returns a value if an error occurred.


This is an error message.