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

Description

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

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_enable_vendor_configs?api.version=1&vendor_id=SomeVendor
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/modsec_enable_vendor_configs?api.version=1&vendor_id=SomeVendor
 Command Line
whmapi1 modsec_enable_vendor_configs vendor_id=SomeVendor


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": {
        "outcomes": [
            {
                "active": 1,
                "ok": 1,
                "config": "modsec_vendor_configs/SomeVendor/example.conf"
            }
        ]
    },
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": 1,
        "command": "modsec_enable_vendor_configs"
    }
}
 Output (XML)
 <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>


Note:

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

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.

 Click here to expand...

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.

Note:

The function only returns a value if an error occurred.

This is an error message.