Page History

Include Page

	LIB:_WHMAPI1Menu
	LIB:_WHMAPI1Menu

Description

Excerpt
This function disables automatic updates for a ModSecurity™ vendor.

Multiexcerpt include

SpaceWithExcerpt	com.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptName	APIDisabledWebServerRole
PageWithExcerpt	LIB:_ServerRoleDisabledAPI

Panel

bgColor	#F2F2F2
borderStyle	none

Examples

Panel

bgColor	#FFFFFF
borderStyle	none

Expand

title	JSON API

Code Block

language	xml

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

Expand

title	XML API

Code Block

language	xml

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

Expand

title	Command Line

Code Block

language	bash

whmapi1 modsec_disable_vendor_updates vendor_id=example

Include Page

	LIB:_WHMAPI1CLINote
	LIB:_WHMAPI1CLINote

Expand

title	Output (JSON)

Code Block

language	text
linenumbers	true

{
    "data": {},
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": 1,
        "command": "modsec_disable_vendor_updates"
    }
}

Expand

title	Output (XML)

Code Block

language	text
linenumbers	true

<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

Parameter Type Description Possible values Example

vendor_id

string

Required

The vendor's unique short name.

A valid string.

example

Returns

This function only returns metadata.

Panel

bgColor	#F2F2F2
borderStyle	none

Function information

Panel

bgColor	#FFFFFF
borderStyle	none

Section

Column

width	40%

API Version:

Column
WHM API 1

Section

Column

width	40%

Available in:

Column
WHM 11.48+

Section

Column

width	40%

Methods:

Column
GET, POST

Section

Column

width	40%

Required Parameters:

Column
`vendor_id`

Section

Column

width	40%

Return Formats:

Column

JSON, XML

Multiexcerpt include

MultiExcerptName	Short Macro
PageWithExcerpt	LIB:_XMLDeprecated

About WHM API 1

Include Page

	LIB:_WHMAPI1About
	LIB:_WHMAPI1About

Find a function

Livesearch

additional	page excerpt
placeholder	Search...
labels	whmapi1

Related functions

Content by Label

showLabels	false
max	5
showSpace	false
sort	modified
excerpt	true
excerptType	simple
operator	AND
cql	label = "modsecurity" and label = "whmapi1"
labels	whmapi1,modsecurity

Child pages

Versions Compared

Old Version 5

New Version Current

Key

Description

Examples

Parameters

Returns

Function information

About WHM API 1

Find a function

Related functions