Cloudflare API | Page Rules › Update A Page Rule

Replaces the configuration of an existing Page Rule. The configuration of the updated Page Rule will exactly match the data passed in the API request.

Security

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

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Zone Write Page Rules Write

path Parameters

zone_id: string

(maxLength: 32)

Identifier

pagerule_id: string

(maxLength: 32)

Identifier

Body parameters

actions: Array<

AlwaysUseHTTPS

AutomaticHTTPSRewrites

BrowserCacheTTL

| 31 more...>

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.

targets: Array<

Target

The rule targets to evaluate on each request.

priority: number

Optional

(default: 1)

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.

status: "active" | "disabled"

Optional

(default: "disabled")

The status of the Page Rule.

Response fields

errors: Array<

ResponseInfo

messages: Array<

ResponseInfo

success: true

Whether the API call was successful

result:

PageRule

Optional

Request example

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/pagerules/$PAGERULE_ID \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{
      "actions": [
        {
          "id": "browser_check",
          "value": "on"
        }
      ],
      "targets": [
        {
          "constraint": {
            "operator": "matches",
            "value": "*example.com/images/*"
          },
          "target": "url"
        }
      ],
      "status": "active"
    }'

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "success": true,
  "result": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353",
    "actions": [
      {
        "id": "browser_check",
        "value": "on"
      }
    ],
    "priority": 0,
    "status": "active",
    "targets": [
      {
        "constraint": {
          "operator": "matches",
          "value": "*example.com/images/*"
        },
        "target": "url"
      }
    ]
  }
}

Domain types

PageRule = { id, actions, created_on, 4 more... }

Target = { constraint, target }

URL target.