Return ModSecurity vendor rule metadata

This function returns the metadata for a ModSecurity™ vendor rule set.

Important:

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

SecurityBasicAuth

Request

query Parameters

url

required

string <url>

The YAML metadata's URL, which describes the vendor and how to obtain its rules.

Note:

The file uses YAML format.
The filename must use the meta_ prefix.
The filename must match the vendor_id value for your vendor.
The filename must end with the .yaml extension.

Example: url=https://www.example.com/vendor1rules/meta_vendor1.yaml

Responses

200

HTTP Request was successful.

Response Schema: application/json

	object
	object

get/modsec_preview_vendor

Request samples

whmapi1 --output=jsonpretty \
  modsec_preview_vendor \
  url='https://www.example.com/vendor1rules/meta_vendor1.yaml'

Response samples

application/json

{"data": {"archive_url": "https://www.example.com/vendor1.zip",
"cpanel_provided": 0,
"description": "This is the Vendor1 ModSecurity Core Rule Set.",
"dist_md5": "307cb5320441ebd712e5581d12100dc9",
"dist_sha512": "b55c09bb1835ed4209f0f3ea4a70d099665363f23d3819c0369be429438d675ba2c749dcefdb85cee682ee0bf485558e67d0b0965fe4799865529d943e8e14cb",
"installed": 1,
"installed_from": "https://www.example.com/vendor1rules/meta_vendor1.yaml",
"name": "Vendor1 ModSecurity Core Rule Set",
"path": "/usr/local/apache/conf/modsec_vendor_configs/vendor1",
"report_url": "https://waf.example.com/api/cpanel_feedback?source=1&rule_set=1.229",
"supported_versions": ["2.9.1",
"2.9.2",
"2.9.3"
],
"vendor_id": "vendor1",
"vendor_url": "http://www.example.com"
},
"metadata": {"command": "modsec_preview_vendor",
"reason": "OK",
"result": 1,
"version": 1
}
}