---
title: "Return ModSecurity vendor rule metadata"
method: GET
path: "/modsec_preview_vendor"
tags: ["ModSecurity", "Rule Vendor Settings"]
---

# Return ModSecurity vendor rule metadata

`GET /modsec_preview_vendor`

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

**Important:**

When you disable the
[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),
the system **disables** this function.

## Query parameters

- `url` string, url, required

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `archive_url` string, url — The URL to the vendor's rule set archive.
    - `cpanel_provided` 1 | 0 — Whether WebPros International, LLC provided the vendor. * `1` — cPanel-provided. * `0` — **Not** cPanel-provided.
    - `description` string — The vendor's description.
    - `dist_md5` string — The download's [MD5](https://en.wikipedia.org/wiki/Md5) checksum value.
    - `dist_sha512` string — The download's [sha512](https://en.wikipedia.org/wiki/SHA-2) hash.
    - `installed` 1 | 0 — Whether the vendor is installed. * `1` — Installed. * `0` — **Not** installed.
    - `installed_from` string, url — The vendor's metadata file URL.
    - `name` string — The vendor's name.
    - `path` string — The absolute path to the directory that contains the vendor's configuration files.
    - `report_url` string, url — The URL to which the system will send reports.
    - `supported_versions` string[] — A list of the ModSecurity versions that the vendor supports.
    - `vendor_id` string — The vendor's unique short name.
    - `vendor_url` string, url — The vendor's website URL.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 1 | 0 — * `1` — Success. * `0` — Failed. Check the `reason` field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)