Cloudflare API | Page Rules

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.

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

Parameters

pageruleId: string

(maxLength: 32)

Identifier.

params:

PageRuleEditParams

zone_id: string

(maxLength: 32)

Path param: Identifier.

actions?: Array<

AlwaysUseHTTPS

AutomaticHTTPSRewrites

BrowserCacheTTL

| 31 more...>

Body param: 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.

priority?: number

Body param: 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"

Body param: The status of the Page Rule.

targets?: Array<

Target

Body param: The rule targets to evaluate on each request.

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.edit('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.delete(, , ):

PageRuleDeleteResponse

| null

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

Deletes an existing Page Rule.

Domain types

PageRule{…}

Target{…}

URL target.