Cloudflare API | Page Rules › List Page Rules

API Reference

Account & User Management

Resource Sharing

AI

Certificate Management

Certificate Authorities

Client Certificates

Custom Certificates

Custom Hostnames

Keyless Certificates

MTLS Certificates

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

Cloudflare One

DNS

Account Custom Nameservers

Domain/Zone Management

IP Addresses

Media

Networking

Magic Cloud Networking

Magic Network Monitoring

Network Interconnects

Observability

Security Center

Radar

Routing & Performance

Rules

Cloud Connector

Managed Transforms

List Page Rules

Get a Page Rule

Create a Page Rule

Update a Page Rule

Edit a Page Rule

Delete a Page Rule

URL Normalization

Security

Schema Validation

Content Scanning

Leaked Credential Checks

Token Validation

Storage & Databases

Threat Intelligence

Brand Protection

Workers & Pages

Browser Rendering

Durable Objects

Workers For Platforms

Shared

Page Rules

page_rules

Methods

List Page Rules -> Envelope<Array<

>>

get/zones/{zone_id}/pagerules

Fetches Page Rules in a zone.

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 Read Zone Write Page Rules Write Page Rules Read

path Parameters

zone_id: string

(maxLength: 32)

Identifier.

query Parameters

direction:

Optional

(default: "desc")

The direction used to sort returned Page Rules.

"asc"

"desc"

match:

Optional

(default: "all")

When set to all, all the search requirements must match. When set to any, only one of the search requirements has to match.

"any"

"all"

order:

Optional

(default: "priority")

The field used to sort returned Page Rules.

"status"

"priority"

status:

Optional

(default: "disabled")

The status of the Page Rule.

"active"

"disabled"

Response fields

errors: Array<{ code, message, documentation_url, 1 more... }>

messages: Array<{ code, message, documentation_url, 1 more... }>

success: true

Whether the API call was successful.

result: Array<

>

Optional

Request example

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/pagerules \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": "023e105f4ecef8ad9ca31a8372d0c353",
      "actions": [
        {
          "id": "browser_check",
          "value": "on"
        }
      ],
      "created_on": "2014-01-01T05:20:00.12345Z",
      "modified_on": "2014-01-01T05:20:00.12345Z",
      "priority": 0,
      "status": "active",
      "targets": [
        {
          "constraint": {
            "operator": "matches",
            "value": "*example.com/images/*"
          },
          "target": "url"
        }
      ]
    }
  ]
}

Get A Page Rule -> Envelope<

>

get/zones/{zone_id}/pagerules/{pagerule_id}

Fetches the details of a Page Rule.

Create A Page Rule -> Envelope<

>

post/zones/{zone_id}/pagerules

Creates a new Page Rule.

Update A Page Rule -> Envelope<

>

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.

Edit A Page Rule -> Envelope<

>

patch/zones/{zone_id}/pagerules/{pagerule_id}

Updates one or more fields of an existing Page Rule.

Delete A Page Rule -> Envelope<{ id }>

delete/zones/{zone_id}/pagerules/{pagerule_id}

Deletes an existing Page Rule.

Domain types

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

Target = { constraint, target }

URL target.