List WAF overrides

Fetches the URI-based WAF overrides in a zone.

application/json

Body

result

required

Any of

allOf {2}

array[object (override) {8}]

allOf {2}

One of

array[object (override) {8}]

object

description

string | null

overrides_components-schemas-description

optional

An informative summary of the current URI-based WAF override.

<= 1024 characters

Example:

Enable Cloudflare Magento ruleset for shop.example.com

groups

object

Cloudflare Client API_groups

optional

An object that allows you to enable or disable WAF rule groups for the current WAF override. Each key of this object must be the ID of a WAF rule group, and each value must be a valid WAF action (usually default or disable). When creating a new URI-based WAF override, you must provide a groups object or a rules object.

Example:

{"ea8687e59929c1fd05ba97574ad43f77":"default"}

string

overrides_components-schemas-id

read-onlyoptional

The unique identifier of the WAF override.

<= 32 characters

Example:

de677e5818985db1285d0e80225f06e5

paused

boolean

schemas-paused

optional

When true, indicates that the WAF package is currently paused.

priority

number

overrides_components-schemas-priority

optional

The relative priority of the current URI-based WAF override when multiple overrides match a single URL. A lower number indicates higher priority. Higher priority overrides may overwrite values set by lower priority overrides.

>= -1000000000<= 1000000000

Example:

rewrite_action

object

rewrite_action

optional

Specifies that, when a WAF rule matches, its configured action will be replaced by the action configured in this object.

rules

object

schemas-rules

optional

An object that allows you to override the action of specific WAF rules. Each key of this object must be the ID of a WAF rule, and each value must be a valid WAF action. Unless you are disabling a rule, ensure that you also enable the rule group that this WAF rule belongs to. When creating a new URI-based WAF override, you must provide a groups object or a rules object.

Example:

{"100015":"disable"}

urls

array[string]

urls

optional

The URLs to include in the current WAF override. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns.

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "description": "Enable Cloudflare Magento ruleset for shop.example.com",
            "groups": {
                "ea8687e59929c1fd05ba97574ad43f77": "default"
            },
            "id": "de677e5818985db1285d0e80225f06e5",
            "paused": true,
            "priority": 1,
            "rewrite_action": {
                "block": "challenge",
                "challenge": "block",
                "default": "block",
                "disable": "challenge",
                "simulate": "disable"
            },
            "rules": {
                "100015": "disable"
            },
            "urls": [
                "shop.example.com/*"
            ]
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

Request

Request samples

Responses