Child pages
  • WHM API 1 Functions - modsec_disable_vendor_updates

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function disables automatic updates for a ModSecurity™ vendor.

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledWebServerRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 




Panel
bgColor#FFFFFF
borderStylenone


Expand
titleJSON API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/modsec_disable_vendor_updates?api.version=1&vendor_id=example



Expand
titleXML API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/modsec_disable_vendor_updates?api.version=1&vendor_id=example



Expand
titleCommand Line


Code Block
languagebash
whmapi1 modsec_disable_vendor_updates vendor_id=example

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
    "data": {},
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": 1,
        "command": "modsec_disable_vendor_updates"
    }
}



Expand
titleOutput (XML)


Code Block
languagetext
linenumberstrue
<result>
  <data/>
  <metadata>
    <version>1</version>
    <reason>OK</reason>
    <result>1</result>
    <command>modsec_disable_vendor_updates</command>
  </metadata>
</result> 


Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
vendor_idstring

Required

The vendor's unique short name.

A valid string. example

Returns

This function only returns metadata.