Update a WAF rule

Deprecated

client.firewall.waf.packages.rules.edit(, , , ?): RuleEditResponse

PATCH/zones/{zone_id}/firewall/waf/packages/{package_id}/rules/{rule_id}

Updates a WAF rule. You can only update the mode/action of the rule.

Note: Applies only to the previous version of WAF managed rules.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Firewall Services Write

ParametersExpand Collapse

packageId: string

Defines the unique identifier of a WAF package.

maxLength32

ruleId: string

Defines the unique identifier of a WAF package.

maxLength32

params: RuleEditParams { zone_id, mode }

zone_id: string

Path param: Defines an identifier of a schema.

maxLength32

mode?: "default" | "disable" | "simulate" | 4 more

Body param: Defines the mode/action of the rule when triggered. You must use a value from the allowed_modes array of the current rule.

One of the following:

"default"

"disable"

"simulate"

"block"

"challenge"

"on"

"off"

ReturnsExpand Collapse

RuleEditResponse = WAFManagedRulesAnomalyRule { id, allowed_modes, description, 4 more } | WAFManagedRulesTraditionalDenyRule { id, allowed_modes, default_mode, 5 more } | WAFManagedRulesTraditionalAllowRule { id, allowed_modes, description, 4 more }

When triggered, anomaly detection WAF rules contribute to an overall threat score that will determine if a request is considered malicious. You can configure the total scoring threshold through the ‘sensitivity’ property of the WAF package.

One of the following:

WAFManagedRulesAnomalyRule { id, allowed_modes, description, 4 more }

id: string

Defines the unique identifier of the WAF rule.

maxLength32

allowed_modes: Array<AllowedModesAnomaly>

Defines the available modes for the current WAF rule. Applies to anomaly detection WAF rules.

One of the following:

"on"

"off"

description: string

Defines the public description of the WAF rule.

group: WAFRuleGroup { id, name }

Defines the rule group to which the current WAF rule belongs.

id?: string

Defines the unique identifier of the rule group.

maxLength32

name?: string

Defines the name of the rule group.

mode: AllowedModesAnomaly

Defines the mode anomaly. When set to on, the current WAF rule will be used when evaluating the request. Applies to anomaly detection WAF rules.

One of the following:

"on"

"off"

package_id: string

Defines the unique identifier of a WAF package.

maxLength32

priority: string

Defines the order in which the individual WAF rule is executed within its rule group.

WAFManagedRulesTraditionalDenyRule { id, allowed_modes, default_mode, 5 more }

When triggered, traditional WAF rules cause the firewall to immediately act upon the request based on the configuration of the rule. A ‘deny’ rule will immediately respond to the request based on the configured rule action/mode (for example, ‘block’) and no other rules will be processed.

id: string

Defines the unique identifier of the WAF rule.

maxLength32

allowed_modes: Array<"default" | "disable" | "simulate" | 2 more>

Defines the list of possible actions of the WAF rule when it is triggered.

One of the following:

"default"

"disable"

"simulate"

"block"

"challenge"

default_mode: "disable" | "simulate" | "block" | "challenge"

Defines the default action/mode of a rule.

One of the following:

"disable"

"simulate"

"block"

"challenge"

description: string

Defines the public description of the WAF rule.

group: WAFRuleGroup { id, name }

Defines the rule group to which the current WAF rule belongs.

id?: string

Defines the unique identifier of the rule group.

maxLength32

name?: string

Defines the name of the rule group.

mode: "default" | "disable" | "simulate" | 2 more

Defines the action that the current WAF rule will perform when triggered. Applies to traditional (deny) WAF rules.

One of the following:

"default"

"disable"

"simulate"

"block"

"challenge"

package_id: string

Defines the unique identifier of a WAF package.

maxLength32

priority: string

Defines the order in which the individual WAF rule is executed within its rule group.

WAFManagedRulesTraditionalAllowRule { id, allowed_modes, description, 4 more }

When triggered, traditional WAF rules cause the firewall to immediately act on the request based on the rule configuration. An ‘allow’ rule will immediately allow the request and no other rules will be processed.

id: string

Defines the unique identifier of the WAF rule.

maxLength32

allowed_modes: Array<"on" | "off">

Defines the available modes for the current WAF rule.

One of the following:

"on"

"off"

description: string

Defines the public description of the WAF rule.

group: WAFRuleGroup { id, name }

Defines the rule group to which the current WAF rule belongs.

id?: string

Defines the unique identifier of the rule group.

maxLength32

name?: string

Defines the name of the rule group.

mode: "on" | "off"

When set to on, the current rule will be used when evaluating the request. Applies to traditional (allow) WAF rules.

One of the following:

"on"

"off"

package_id: string

Defines the unique identifier of a WAF package.

maxLength32

priority: string

Defines the order in which the individual WAF rule is executed within its rule group.

Update a WAF rule

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const response = await client.firewall.waf.packages.rules.edit(
  'a25a9a7e9c00afc1fb2e0245519d725b',
  'a25a9a7e9c00afc1fb2e0245519d725b',
  { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
);

console.log(response);

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "f939de3be84e66e757adcdcb87908023",
    "allowed_modes": [
      "on",
      "off"
    ],
    "description": "SQL injection prevention for SELECT statements",
    "group": {
      "id": "de677e5818985db1285d0e80225f06e5",
      "name": "Project Honey Pot"
    },
    "mode": "on",
    "package_id": "a25a9a7e9c00afc1fb2e0245519d725b",
    "priority": "priority"
  },
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "f939de3be84e66e757adcdcb87908023",
    "allowed_modes": [
      "on",
      "off"
    ],
    "description": "SQL injection prevention for SELECT statements",
    "group": {
      "id": "de677e5818985db1285d0e80225f06e5",
      "name": "Project Honey Pot"
    },
    "mode": "on",
    "package_id": "a25a9a7e9c00afc1fb2e0245519d725b",
    "priority": "priority"
  },
  "success": true
}