Add ModSecurity vendor rules

This function adds a new ModSecurity™ vendor rule set to the server.

Important:

When you disable the Web Server role, the system disables this function.

SecurityBasicAuth

Request

query Parameters

url required	string <url> The YAML metadata that describes the vendor and how to obtain its rules. Example: url=https://example.com/update/meta_MyVendor.yaml
enabled	integer Default: 1 Whether to enable the vendor. `1` — Enabled. `0` — Disabled. Enum: 1 0 Example: enabled=1

Responses

200

HTTP Request was successful.

Response Schema: application/json

	object
	object

get/modsec_add_vendor

Request samples

whmapi1 --output=jsonpretty \
  modsec_add_vendor \
  url='https://example.com/update/meta_MyVendor.yaml'

Response samples

application/json

{"data": {"archive_url": "http://example.com/update/MyVendor.zip",
"cpanel_provided": 0,
"description": "This is an example of a custom vendor set (updated)",
"dist_md5": "307cb5320441ebd712e5581d12100dc9",
"dist_sha512": "b55c09bb1835ed4209f0f3ea4a70d099665363f23d3819c0369be429438d675ba2c749dcefdb85cee682ee0bf485558e67d0b0965fe4799865529d943e8e14cb",
"enabled": 1,
"inst_dist": "MyVendor-2",
"installed": 1,
"installed_from": "https://example.com/update/meta_MyVendor.yaml",
"name": "My Vendor",
"path": "/usr/local/apache/conf/modsec_vendor_configs/MyVendor",
"report_url": "https://waf.example.com/api/cpanel_feedback?source=1&rule_set=1.229",
"supported_versions": ["2.7.5",
"2.7.7",
"2.8.0",
"2.9.0",
"2.9.1",
"2.9.2",
"2.9.3"
],
"vendor_id": "MyVendor",
"vendor_url": "http://www.example.com"
},
"metadata": {"command": "modsec_add_vendor",
"reason": "OK",
"result": 1,
"version": 1
}
}