Understanding and configuring Cloudflare Page Rules (Page Rules Tutorial)

​​ Overview

You can define a page rule to trigger one or more actions whenever a certain URL pattern is matched. Page Rules are available in the Rules app, in the Page Rules tab.

The default number of allowed page rules depends on the domain plan as shown below.

You can  purchase additional rules Open external link  (up to a maximum of 100) for domains in the Free, Lite, Pro, Pro Plus, and Business plans.

​​ Before getting started

It is important to understand two basic Page Rules behaviors:

• Only the highest priority matching page rule takes effect on a request.
• Page rules are prioritized in descending order in the Cloudflare dashboard, with the highest priority rule at the top.

A page rule matches a URL pattern based on the following format (comprised of five segments): ://<:port>/?<query_string>

An example URL with these four segments looks like:

https://www.example.com:443/image.png?parameter1=value1

The scheme and port segments are optional. If omitted, scheme matches both http:// and https:// protocols. If no port is specified, the rule will match all ports.

Finally, you can disable a page rule at any time. While a rule is disabled, actions won’t trigger, but the rule still appears in the Rules app in the Page Rules tab, is editable, and counts against the number of rules allowed for your domain. The Save as Draft option creates a page rule that is disabled by default.

​​ Create a page rule

The steps to create a page rule are:

1. Log in to the Cloudflare dashboard.
2. Select the domain where you want to add the page rule.
3. Click the Rules app.
4. In the Page Rules tab**,** click Create Page Rule. The Create Page Rule for  dialog opens.
5. Under If the URL matches, enter the URL or URL pattern that should match the rule. Learn more about wildcard matching Open external link
6. Next, under Then the settings are: click + Add a Setting and select the desired setting from the dropdown. You can include more than one setting per rule. Learn more about settings in the  summary below Open external link .
7. In the Order dropdown, specify the desired order: First, Last or Custom.
8. To save, click one of the following options:
   • Save as Draft to save the rule and leave it disabled.
   • Save and Deploy to save the rule and enable it immediately.

​​ Edit a page rule

To modify an existing rule:

1. Log in to the Cloudflare dashboard.
2. Select the domain where you want to edit your page rule.
3. Click the Rules app.
4. In the Page Rules tab, locate the rule to edit.
5. Proceed to make the necessary changes, as follows:
   • To enable or disable a rule, click the On/Off toggle.
   • To modify the URL pattern, settings, and order, click the Edit button (wrench icon). In the dialog, enter the information you’d like to change.
   • To remove a rule, click the Delete button (x icon) and confirm by clicking OK in the Confirm dialog.

​​ Understand wildcard matching and referencing

You can use the asterisk (*) in any URL segment to match certain patterns. For example,

example.com/t*st

Would match:

example.com/test
example.com/toast
example.com/trust

example.com/foo/* does not match example.com/foo.  However, example.com/foo* does.

​​ Helpful tips

• To match both http and https, just write example.com. It is not necessary to write *example.com.
• To match every page on a domain, write example.com/*. Just writing example.com won’t work.
• To match every page on a domain and it’s subdomains, write *example.com/*. Just writing example.com won’t work.
• A wildcard (*) in a Page Rule URL will match even if no characters are present, and may include any part of the URL, including the query string.

​​ Referencing wildcard matches

You can reference a matched wildcard later using the $X syntax. X indicates the index of a glob pattern. As such, $1 represents the first wildcard match, $2 the second wildcard match, and so on.

This is specifically useful with the Forwarding URL setting. For example:

You could forward:

http://*.example.com/*

to:

http://example.com/images/$1/$2.jpg

This rule would match:

http://cloud.example.com/flare.jpg

which ends up being forwarded to:

http://example.com/images/cloud/flare.jpg

To use a literal $ character in the forwarding URL, escape it by adding a backslash (\) in front: \$.

​​ Summary of Page Rules Settings

Settings control the action Cloudflare takes once a request matches the URL pattern defined in a page rule. You can use settings to enable and disable multiple Cloudflare features across several of the dashboard apps. Note that:

• Some settings require a Pro, Business or Enterprise domain plan.
• You can specify more than one setting to apply when the rule triggers.

Below is the full list of settings available, presented in the order that they appear in the Cloudflare Page Rules UI.

​​ Known Issues

Page Rule configuration issue leading to “Error 500 (Internal server error)”

Root cause: This may be due to a configuration issue on a Page Rule. When creating a Page Rule that uses two wildcards, like a Forwarding URL rule, it is possible to create a rule that mentions the second wildcard with the $2 placeholder. Refer to the example below:

When updating the same rule, you can remove one of the wildcard in the If the URL matches field and save it. Refer to the example below:

If you do so, the $2 placeholder reference a wildcard that does not exist anymore, and as such, an “Error 500 (Internal server error)” is thrown when a URL triggers the page rule.

Resolution: Update the Page Rule and remove the reference $2 to the second wildcard. If there is only one wildcard, then only $1 can be used.

​​ Additional details

​​ Bypass Cache on Cookie setting

This setting is available to business and enterprise customers.

The Bypass Cache on Cookie setting supports basic regular expressions (regex) as follows:

• A pipe operator (represented by |) to match multiple cookies using OR boolean logic. For example, bypass=.*|PHPSESSID=.* would bypass the cache if either a cookie called bypass or PHPSESSID were set, regardless of the cookie’s value.
• The wildcard operator (represented by .*), such that a rule value of “t.*st=” would match both a cookie called test and one called teeest.

Limitations include:

• 150 chars per cookie regex
• 12 wildcards per cookie regex
• 1 wildcard in between each | in the cookie regex

To learn how to configure Bypass Cache on Cookie with a variety of platforms, review these articles:

• Caching Anonymous Page Views with WordPress or WooCommerce Open external link
• Caching Anonymous Page Views with Magento 1 and Magento 2 Open external link
• How do I cache static HTML? Open external link

Note: If you add both this setting and the enterprise-only Cache On Cookie setting to the same page rule, Cache On Cookie takes precedence over Bypass Cache on Cookie.

​​ Zone name occurrences must end with a slash

When saving a Page Rule, Cloudflare will ensure that there is a slash after each occurrence of the current zone name in the If the URL matches field. For example, if the current zone name is example.com, then:

• example.com will be saved as example.com/
• example.com/path/example.com will be saved as example.com/path/example.com/

Note that example.com/some-path/cloudflare.com will be saved without a final slash, since the zone name is not cloudflare.com.

​​ Network ports supported by Page Rules

If you specify a port in the If the URL matches field of a Page Rule, it must be one of the following:

• One of the HTTP/HTTPS ports compatible with Cloudflare’s proxy.
• A custom port of a Cloudflare Spectrum HTTPS application.

​​ Using Page Rules with Workers

If the URL of the current request matches both a Page Rule and a Workers custom route, some Pages Rules settings will not be applied. For details on using Page Rules with Workers, refer to Workers: Page Rules in the developers documentation.

​​ Related resources

• Recommended Page Rules to Consider Open external link
• What subdomains are appropriate for orange/grey clouds? Open external link
• How do I use Cache Everything with Cloudflare? Open external link
• How do I cache static HTML? Open external link
• Offline error message when updating or accessing the admin section of my content management system Open external link