---
title: "Update ModSecurity vendor ruleset"
method: GET
path: "/modsec_update_vendor"
tags: ["ModSecurity", "Rule Vendor Settings"]
---

# Update ModSecurity vendor ruleset

`GET /modsec_update_vendor`

This function updates a vendor with the current version of the 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
    - `diagnostics` object — A list of diagnostic information about the update.
      - `added_configs` string[] — A list of the ModSecurity configuration files that the update added.
      - `deleted_configs` string[] — An array of objects containing the ModSecurity configuration files that the update removed.
      - `new_configs` object[] — A complete list of configuration files that the update modified.
        - `active` 1 | 0 — Whether the configuration file is active. * `1` — Active. * `0` — **Not** active.
        - `config` string — The file path to the configuration file, relative to the `/usr/local/apache/conf/` Apache configuration directory.
        - `vendor_id` string — The vendor's unique name.
      - `prev_configs` object[] — A list of configuration files in the old version.
        - `config` string — The file path of the configuration file, relative to the `/usr/local/apache/conf/` Apache configuration directory.
    - `vendor` object — A list of updated vendor information.
      - `archive_url` string, url — The URL to download the vendor rules.
      - `cpanel_provided` 1 | 0 — Whether WebPros International, LLC provided the rule set. * `1` — Provided by WebPros International, LLC. * `0` — Not provided WebPros International, LLC.
      - `description` string — The vendor's description.
      - `dist_md5` string — The download's [MD5](https://en.wikipedia.org/wiki/MD5) checksum value.
      - `enabled` 1 | 0 — Whether the vendor is enabled. * `1` — Enabled. * `0` — Disabled.
      - `inst_dist` string — The unique identifier for the rule set version.
      - `installed` 1 | 0 — Whether the vendor is installed. * `1` — Installed. * `0` — **Not** installed.
      - `installed_from` string, url — The URL to the vendor's metadata file.
      - `name` string — The vendor's name.
      - `path` string — The file path to the vendor's ModSecurity configuration files.
      - `report_url` string, url — The URL that the vendor uses to receive problem reports.
      - `vendor_id` string — The vendor's unique short name.
      - `vendor_url` string, url — The URL to 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)