Cloudflare API | Page Rules

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"

(default: "disabled")

The status of the Page Rule.

targets: Array<

Target

The rule targets to evaluate on each request.

Request example

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const pageRules = await client.pageRules.list({ zone_id: '023e105f4ecef8ad9ca31a8372d0c353' });

console.log(pageRules);

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

client.pageRules.get(, , ):

PageRule

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

Fetches the details of a Page Rule.

client.pageRules.create(, ):

PageRule

post/zones/{zone_id}/pagerules

Creates a new Page Rule.

client.pageRules.update(, , ):

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.

client.pageRules.edit(, , ):

PageRule

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

Updates one or more fields of an existing Page Rule.

client.pageRules.delete(, , ):

PageRuleDeleteResponse

| null

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

Deletes an existing Page Rule.

Domain types

PageRule{…}

Target{…}

URL target.