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

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Description

This function enables automatic updates for a ModSecurity™ vendor.

Examples 


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


Notes:

  • Unless otherwise noted, 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": {},
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": 1,
        "command": "modsec_enable_vendor_updates"
    }
}
 Output (XML)
<result>
  <data/>
  <metadata>
    <version>1</version>
    <reason>OK</reason>
    <result>1</result>
    <command>modsec_enable_vendor_updates</command>
  </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.example

Returns

This function only returns metadata.

  • No labels