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.

Authorizations:
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

Response Schema: application/json
object
object

Request samples

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

Response samples

Content type
application/json
{}