---
title: "Return ModSecurity vendors"
method: GET
path: "/modsec_get_vendors"
tags: ["ModSecurity", "Rule Vendor Settings"]
---

# Return ModSecurity vendors

`GET /modsec_get_vendors`

The function returns a list of configured ModSecurity™ vendors.

**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.

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `vendors` object[] — An array of objects that represent the list of configured vendors on the system.
      - `archive_url` string, url — The URL to download the vendor rules.
      - `configs` object[] — A list of information about the configuration files that the vendor provides.
        - `active` 1 | 0 — Whether the configuration is active. * `1` — Active. * `0` — Inactive.
        - `config` string — The configuration file path, relative to the `/usr/local/apache/conf` directory.
        - `vendor_id` string — The vendor's unique short name.
      - `cpanel_provided` 1 | 0 — Whether cPanel & WHM installed the vendor rule set. * `1` — Installed. * `0` — **Not** installed.
      - `description` string — The ModSecurity 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.
      - `enabled` 1 | 0 — Whether the vendor is enabled. * `1` — Enabled. * `0` — Disabled.
      - `in_use` integer — The number of configuration files in the vendor rule set.
      - `inst_dist` string — The rule set version's unique identifier.
      - `installed` 1 | 0 — Whether the vendor is installed. * `1` — Installed. * `0` — **Not** installed.
      - `installed_from` string — The URL to the vendor's metadata file.
      - `name` string — The vendor's name.
      - `path` string — The full path to the vendor's ModSecurity configuration files.
      - `report_url` string, url — The URL of the vendor's Report Receiver API endpoint that reports problems with the vendor's rules. **Note:** The function may not always return this parameter.
      - `supported_versions` string[] — A list of the ModSecurity versions that the vendor supports.
      - `update` 1 | 0 — Whether the vendor rule set can receive automatic updates. * `1` — Can receive automatic updates. * `0` — **Cannot** receive automatic updates.
      - `vendor_id` string — The vendor's unique short name.
      - `vendor_url` string, url — The URL of the vendor's website.
  - `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)