Edit a Page Rule

PATCH

https://api.cloudflare.com/client/v4/zones/{zone_identifier}/pagerules/{identifier}

Last modified:2022-12-16 13:48:34

Updates one or more fields of an existing Page Rule.

Request

Path Params

identifier

string

required

zone_identifier

string

required

Body Params application/json

actions

array [oneOf]

optional

The set of actions to perform if the targets of this rule match the request. Actions can redirect to another URL or override settings, but not both.

Example:

[{"id":"browser_check","value":"on"}]

object (route)

optional

priority

integer

optional

The priority of the rule, used to define which Page Rule is processed over another. A higher number indicates a higher priority. For example, if you have a catch-all Page Rule (rule A: /images/*) but want a more specific Page Rule to take precedence (rule B: /images/special/*), specify a higher priority for rule B so it overrides rule A.

Default:

status

enum<string>

optional

The status of the Page Rule.

Allowed values:

activedisabled

Default:

disabled

Example:

active

targets

array[null (target) {1}]

optional

The rule targets to evaluate on each request.

Example:

[{"constraint":{"operator":"matches","value":"*example.com/images/*"},"target":"url"}]

object

url_target

optional

URL target.

Example

{
    "actions": [
        {
            "id": "browser_check",
            "value": "on"
        }
    ],
    "priority": 1,
    "status": "active",
    "targets": [
        {
            "constraint": {
                "operator": "matches",
                "value": "*example.com/images/*"
            },
            "target": "url"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.cloudflare.com/client/v4/zones//pagerules/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "actions": [
        {
            "id": "browser_check",
            "value": "on"
        }
    ],
    "priority": 1,
    "status": "active",
    "targets": [
        {
            "constraint": {
                "operator": "matches",
                "value": "*example.com/images/*"
            },
            "target": "url"
        }
    ]
}'

Responses

🟢200Edit a Page Rule response

application/json

Body

allOf {2}

optional

object (api-response-single)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

object

optional

result

object

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {},
    "success": true
}

🟢200Edit a Page Rule response failure

Modified at 2022-12-16 13:48:34

Get a Page Rule

Update a Page Rule