Cloudflare API | Page Rules

Trust and Safety Write Trust and Safety Read 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: Mutual TLS 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

pageruleId: string

(maxLength: 32)

Identifier.

params:

PageRuleGetParams

zone_id: string

(maxLength: 32)

Identifier.

Returns

PageRule

id: string

(maxLength: 32)

Identifier.

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.

created_on: string

(format: date-time)

The timestamp of when the Page Rule was created.

modified_on: string

(format: date-time)

The timestamp of when the Page Rule was last modified.

priority: number

(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"

(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 pageRule = await client.pageRules.get('023e105f4ecef8ad9ca31a8372d0c353', {
  zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
});

console.log(pageRule.id);

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.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.