Description

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

Examples 





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




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




whmapi1 modsec_disable_vendor_configs vendor_id=SomeVendor



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




 <result>
  <data>
    <outcomes>
      <active>0</active>
      <config>modsec_vendor_configs/SomeVendor/example.conf</config>
      <ok>1</ok>
    </outcomes>
  </data>
  <metadata>
    <command>modsec_disable_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 disable operation.

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

 

active

Boolean

Whether the configuration file is active.

This function returns this value in the outcomes array.

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

ok

Boolean

Whether the function successfully disabled the configuration file.

This function returns this value in the outcomes array.

  • 1 — Disabled.
  • 0 — Enabled.
 1

config

string

The configuration file path.

This function returns this value in the outcomes array.

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


modsec_vendor_configs/SomeVendor/example.conf


exception

string

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

This function returns this value in the outcomes array.

This function only returns a value if an error occurred.


A valid string.This is an error message.



Function information



API Version:


WHM API 1




Available in:


WHM 11.48+




Methods:


GET, POST




Required Parameters:


vendor_id




Return Formats:


JSON, XML



About WHM API 1

Find a function

Related functions