Cloudflare API | Page Rules › Get A Page Rule

Trust and Safety Write Trust and Safety Read Cloudflare Zero Trust PII Read Zaraz Edit Zaraz Read Zaraz Admin Access: Apps and Policies Revoke Access: Apps and Policies Write Access: Apps and Policies Read Access: Apps and Policies Revoke Access: Certificates Write Access: Organizations, Identity Providers, and Groups Write Zone Settings Write Zone Settings Read Zone Read DNS Read Workers Scripts Write Workers Scripts Read Zone Write Workers Routes Write Workers Routes Read Stream Write Stream Read SSL and Certificates Write SSL and Certificates Read Logs Write Logs Read Cache Purge Page Rules Write Page Rules Read Load Balancers Write Load Balancers Read Firewall Services Write Firewall Services Read DNS Write Apps Write Analytics Read Access: Apps and Policies Write Access: Apps and Policies Read

Parameters

zone_id: string

(maxLength: 32)

Identifier

pagerule_id: string

(maxLength: 32)

Identifier

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 \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

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"
      }
    ]
  }
}

List Page Rules -> Envelope<Array<

PageRule

get/zones/{zone_id}/pagerules

Fetches Page Rules in a zone.

Update A Page Rule -> Envelope<

PageRule

put/zones/{zone_id}/pagerules/{pagerule_id}

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.

Domain types

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

Target = { constraint, target }

URL target.