Get a Page Rule

client.pageRules.get(, , ?): PageRule { id, actions, created_on, 4 more }

GET/zones/{zone_id}/pagerules/{pagerule_id}

Fetches the details of a Page Rule.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Trust and Safety WriteTrust and Safety ReadZero Trust: PII ReadZaraz EditZaraz ReadZaraz AdminAccess: Apps and Policies RevokeAccess: Apps and Policies WriteAccess: Apps and Policies ReadAccess: Apps and Policies RevokeAccess: Mutual TLS Certificates WriteAccess: Organizations, Identity Providers, and Groups WriteZone Settings WriteZone Settings ReadZone ReadDNS ReadWorkers Scripts WriteWorkers Scripts ReadZone WriteWorkers Routes WriteWorkers Routes ReadStream WriteStream ReadSSL and Certificates WriteSSL and Certificates ReadLogs WriteLogs ReadCache PurgePage Rules WritePage Rules ReadLoad Balancers WriteLoad Balancers ReadFirewall Services WriteFirewall Services ReadDNS WriteApps WriteAnalytics ReadAccess: Apps and Policies WriteAccess: Apps and Policies Read

ParametersExpand Collapse

pageruleId: string

Identifier.

maxLength32

params: PageRuleGetParams { zone_id }

zone_id: string

Identifier.

maxLength32

ReturnsExpand Collapse

PageRule { id, actions, created_on, 4 more }

id: string

Identifier.

maxLength32

actions: Array<AlwaysUseHTTPS { id } | AutomaticHTTPSRewrites { id, value } | BrowserCacheTTL { id, value } | 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.

One of the following:

AlwaysUseHTTPS { id }

id?: "always_use_https"

If enabled, any http://`` URL is converted to https://` through a 301 redirect.

AutomaticHTTPSRewrites { id, value }

id?: "automatic_https_rewrites"

Turn on or off Automatic HTTPS Rewrites.

value?: "on" | "off"

The status of Automatic HTTPS Rewrites.

One of the following:

"on"

"off"

BrowserCacheTTL { id, value }

id?: "browser_cache_ttl"

Control how long resources cached by client browsers remain valid.

value?: number

The number of seconds to cache resources for. Setting this to 0 enables "Respect Existing Headers".

maximum31536000

minimum0

BrowserCheck { id, value }

id?: "browser_check"

Inspect the visitor's browser for headers commonly associated with spammers and certain bots.

value?: "on" | "off"

The status of Browser Integrity Check.

One of the following:

"on"

"off"

BypassCacheOnCookie { id, value }

id?: "bypass_cache_on_cookie"

Bypass cache and fetch resources from the origin server if a regular expression matches against a cookie name present in the request.

value?: string

The regular expression to use for matching cookie names in the request. Refer to Bypass Cache on Cookie setting to learn about limited regular expression support.

maxLength150

minLength1

CacheByDeviceType { id, value }

id?: "cache_by_device_type"

Separate cached content based on the visitor's device type.

value?: "on" | "off"

The status of Cache By Device Type.

One of the following:

"on"

"off"

CacheDeceptionArmor { id, value }

id?: "cache_deception_armor"

Protect from web cache deception attacks while still allowing static assets to be cached. This setting verifies that the URL's extension matches the returned Content-Type.

value?: "on" | "off"

The status of Cache Deception Armor.

One of the following:

"on"

"off"

CacheKeyFields { id, value }

id?: "cache_key_fields"

Control specifically what variables to include when deciding which resources to cache. This allows customers to determine what to cache based on something other than just the URL.

value?: Value { cookie, header, host, 2 more }

host?: Host { resolved }

Determines which host header to include in the Cache Key.

resolved?: boolean

Whether to include the Host header in the HTTP request sent to the origin.

query_string?: QueryString { exclude, include }

Controls which URL query string parameters go into the Cache Key. Exactly one of include or exclude is expected.

exclude?: "*" | Array<string>

Ignore all query string parameters.

One of the following:

"*"

Array<string>

include?: "*" | Array<string>

Include all query string parameters.

One of the following:

"*"

Array<string>

user?: User { device_type, geo, lang }

Feature fields to add features about the end-user (client) into the Cache Key.

device_type?: boolean

Classifies a request as mobile, desktop, or tablet based on the User Agent.

geo?: boolean

Includes the client's country, derived from the IP address.

lang?: boolean

Includes the first language code contained in the Accept-Language header sent by the client.

CacheLevel { id, value }

id?: "cache_level"

Apply custom caching based on the option selected.

value?: "bypass" | "basic" | "simplified" | 2 more

bypass: Cloudflare does not cache.
basic: Delivers resources from cache when there is no query string.
simplified: Delivers the same resource to everyone independent of the query string.
aggressive: Caches all static content that has a query string.
cache_everything: Treats all content as static and caches all file types beyond the Cloudflare default cached content.

One of the following:

"bypass"

"basic"

"simplified"

"aggressive"

"cache_everything"

CacheOnCookie { id, value }

id?: "cache_on_cookie"

Apply the Cache Everything option (Cache Level setting) based on a regular expression match against a cookie name.

value?: string

The regular expression to use for matching cookie names in the request.

maxLength150

minLength1

CacheTTLByStatus { id, value }

id?: "cache_ttl_by_status"

Enterprise customers can set cache time-to-live (TTL) based on the response status from the origin web server. Cache TTL refers to the duration of a resource in the Cloudflare network before being marked as stale or discarded from cache. Status codes are returned by a resource's origin. Setting cache TTL based on response status overrides the default cache behavior (standard caching) for static files and overrides cache instructions sent by the origin web server. To cache non-static assets, set a Cache Level of Cache Everything using a Page Rule. Setting no-store Cache-Control or a low TTL (using max-age/s-maxage) increases requests to origin web servers and decreases performance.

value?: Record<string, "no-cache" | "no-store" | number>

A JSON object containing status codes and their corresponding TTLs. Each key-value pair in the cache TTL by status cache rule has the following syntax

status_code: An integer value such as 200 or 500. status_code matches the exact status code from the origin web server. Valid status codes are between 100-999.
status_code_range: Integer values for from and to. status_code_range matches any status code from the origin web server within the specified range.
value: An integer value that defines the duration an asset is valid in seconds or one of the following strings: no-store (equivalent to -1), no-cache (equivalent to 0).

One of the following:

"no-cache" | "no-store"

One of the following:

"no-cache"

"no-store"

number

DisableApps { id }

id?: "disable_apps"

Turn off all active Cloudflare Apps (deprecated).

DisablePerformance { id }

id?: "disable_performance"

Turn off Rocket Loader, and Polish.

DisableSecurity { id }

id?: "disable_security"

Turn off Email Obfuscation, Rate Limiting (previous version, deprecated), Scrape Shield, URL (Zone) Lockdown, and WAF managed rules (previous version, deprecated).

DisableZaraz { id }

id?: "disable_zaraz"

Turn off Zaraz.

EdgeCacheTTL { id, value }

id?: "edge_cache_ttl"

Specify how long to cache a resource in the Cloudflare global network. Edge Cache TTL is not visible in response headers.

value?: number

maximum31536000

minimum1

EmailObfuscation { id, value }

id?: "email_obfuscation"

Turn on or off Email Obfuscation.

value?: "on" | "off"

The status of Email Obfuscation.

One of the following:

"on"

"off"

ExplicitCacheControl { id, value }

id?: "explicit_cache_control"

Origin Cache Control is enabled by default for Free, Pro, and Business domains and disabled by default for Enterprise domains.

value?: "on" | "off"

The status of Origin Cache Control.

One of the following:

"on"

"off"

ForwardingURL { id, value }

id?: "forwarding_url"

Redirects one URL to another using an HTTP 301/302 redirect. Refer to Wildcard matching and referencing.

value?: Value { status_code, url }

status_code?: 301 | 302

The status code to use for the URL redirect. 301 is a permanent redirect. 302 is a temporary redirect.

One of the following:

301

302

url?: string

The URL to redirect the request to. Notes: ${num} refers to the position of '*' in the constraint value.

maxLength1500

HostHeaderOverride { id, value }

id?: "host_header_override"

Apply a specific host header.

value?: string

The hostname to use in the Host header

minLength1

IPGeolocation { id, value }

id?: "ip_geolocation"

Cloudflare adds a CF-IPCountry HTTP header containing the country code that corresponds to the visitor.

value?: "on" | "off"

The status of adding the IP Geolocation Header.

One of the following:

"on"

"off"

Mirage { id, value }

id?: "mirage"

Cloudflare Mirage reduces bandwidth used by images in mobile browsers. It can accelerate loading of image-heavy websites on very slow mobile connections and HTTP/1.

value?: "on" | "off"

The status of Mirage.

One of the following:

"on"

"off"

OpportunisticEncryption { id, value }

id?: "opportunistic_encryption"

Opportunistic Encryption allows browsers to access HTTP URIs over an encrypted TLS channel. It's not a substitute for HTTPS, but provides additional security for otherwise vulnerable requests.

value?: "on" | "off"

The status of Opportunistic Encryption.

One of the following:

"on"

"off"

OriginErrorPagePassThru { id, value }

id?: "origin_error_page_pass_thru"

Turn on or off Cloudflare error pages generated from issues sent from the origin server. If enabled, this setting triggers error pages issued by the origin.

value?: "on" | "off"

The status of Origin Error Page Passthru.

One of the following:

"on"

"off"

Polish { id, value }

id?: "polish"

Apply options from the Polish feature of the Cloudflare Speed app.

value?: "off" | "lossless" | "lossy"

The level of Polish you want applied to your origin.

One of the following:

"off"

"lossless"

"lossy"

ResolveOverride { id, value }

id?: "resolve_override"

Change the origin address to the value specified in this setting.

value?: string

The origin address you want to override with.

RespectStrongEtag { id, value }

id?: "respect_strong_etag"

Turn on or off byte-for-byte equivalency checks between the Cloudflare cache and the origin server.

value?: "on" | "off"

The status of Respect Strong ETags

One of the following:

"on"

"off"

ResponseBuffering { id, value }

id?: "response_buffering"

Turn on or off whether Cloudflare should wait for an entire file from the origin server before forwarding it to the site visitor. By default, Cloudflare sends packets to the client as they arrive from the origin server.

value?: "on" | "off"

The status of Response Buffering

One of the following:

"on"

"off"

RocketLoader { id, value }

id?: "rocket_loader"

Turn on or off Rocket Loader in the Cloudflare Speed app.

value?: "on" | "off"

The status of Rocket Loader

One of the following:

"on"

"off"

SecurityLevel { id, value }

id?: "security_level"

Control options for the Security Level feature from the Security app.

value?: "off" | "essentially_off" | "low" | 3 more

One of the following:

"off"

"essentially_off"

"low"

"medium"

"high"

"under_attack"

SortQueryStringForCache { id, value }

id?: "sort_query_string_for_cache"

Turn on or off the reordering of query strings. When query strings have the same structure, caching improves.

value?: "on" | "off"

The status of Query String Sort

One of the following:

"on"

"off"

SSL { id, value }

id?: "ssl"

Control options for the SSL feature of the Edge Certificates tab in the Cloudflare SSL/TLS app.

value?: "off" | "flexible" | "full" | 2 more

The encryption mode that Cloudflare uses to connect to your origin server.

One of the following:

"off"

"flexible"

"full"

"strict"

"origin_pull"

TrueClientIPHeader { id, value }

id?: "true_client_ip_header"

Turn on or off the True-Client-IP Header feature of the Cloudflare Network app.

value?: "on" | "off"

The status of True Client IP Header.

One of the following:

"on"

"off"

WAF { id, value }

id?: "waf"

Turn on or off WAF managed rules (previous version, deprecated). You cannot enable or disable individual WAF managed rules via Page Rules.

value?: "on" | "off"

The status of WAF managed rules (previous version).

One of the following:

"on"

"off"

created_on: string

The timestamp of when the Page Rule was created.

formatdate-time

modified_on: string

The timestamp of when the Page Rule was last modified.

formatdate-time

priority: number

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"

The status of the Page Rule.

One of the following:

"active"

"disabled"

targets: Array<Target { constraint, target } >

The rule targets to evaluate on each request.

constraint?: Constraint { operator, value }

String constraint.

operator: "matches" | "contains" | "equals" | 2 more

The matches operator can use asterisks and pipes as wildcard and 'or' operators.

One of the following:

"matches"

"contains"

"equals"

"not_equal"

"not_contain"

value: string

The URL pattern to match against the current request. The pattern may contain up to four asterisks ('*') as placeholders.

target?: "url"

A target based on the URL of the request.

Get a Page Rule

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);

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

Returns Examples

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