---
title: "Update staged ModSecurity rule"
method: GET
path: "/modsec_edit_rule"
tags: ["ModSecurity", "Rule Settings"]
---

# Update staged ModSecurity rule

`GET /modsec_edit_rule`

This function stages edits to a ModSecurity™ rule. The system does **not** save changes
directly to the configuration file. Instead, it stages the changes to the configuration
file's `.STAGE` file (for example, for the `example.conf` file, the system stages changes
in the `example.conf.STAGE` file).

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

- `config` string, required
- `id` integer, required
- `rule` string, required

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `rule` object — A list of information about the new ModSecurity rule.
      - `disabled` 1 | 0 — Whether the ModSecurity rule is disabled. * `1` — Disabled. * `0` — Enabled.
      - `id` integer — The ModSecurity rule's ID.
      - `meta_msg` string — The ModSecurity rule's description, if one exists.
      - `rule` string — The ModSecurity rule's text.
  - `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)