[Rules] Update Custom Errors #19905
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| --- | ||
| title: "Custom Errors (beta): Stored Assets & Account-level Rules" | ||
| description: Cloudflare introduces Custom Errors (beta), building on Custom Error Responses with new asset storage capabilities | ||
| products: | ||
| - rules | ||
| date: 2025-02-11T11:00:00Z | ||
| --- | ||
|
|
||
| Cloudflare introduces [Custom Errors](/rules/custom-errors/) (beta), building on Custom Error Responses with new asset storage capabilities. This update allows users to store externally hosted error pages at Cloudflare edge and reference them in custom error rules, eliminating the need to supply inline content. | ||
|
|
||
| New capabilities: | ||
|
|
||
| - **Custom error assets** – Fetch and store external error pages at the edge for use in error responses. | ||
| - **Account-Level custom errors** – Define error handling rules and assets at the account level for consistency across multiple zones. Zone-level rules take precedence over account-level ones, and assets are not shared between levels. | ||
|
|
||
| To store an external error page on the Cloudflare global network, submit a `POST` request to create an asset: | ||
|
|
||
| ```bash | ||
| curl "https://api.cloudflare.com/client/v4/zones/{zone_id}/custom_pages/assets" \ | ||
| --header "Authorization: Bearer <API_TOKEN>" \ | ||
| --header 'Content-Type: application/json' \ | ||
| --data '{ | ||
| "name": "maintenance", | ||
| "description": "Maintenance template page", | ||
| "url": "https://example.com/" | ||
| }' | ||
| ``` | ||
|
|
||
| Then, reference the stored asset in a custom error rule: | ||
|
|
||
| ```bash | ||
| curl --request PUT \ | ||
| "https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/phases/http_custom_errors/entrypoint" \ | ||
| --header "Authorization: Bearer <API_TOKEN>" \ | ||
| --header 'Content-Type: application/json' \ | ||
| --data '{ | ||
| "rules": [ | ||
| { | ||
| "action": "serve_error", | ||
| "action_parameters": { | ||
| "asset_name": "maintenance", | ||
| "content_type": "text/html", | ||
| "status_code": 503 | ||
| }, | ||
| "enabled": true, | ||
| "expression": "http.request.uri.path contains \"error\"" | ||
| } | ||
| ] | ||
| }' | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some redirects have been moved. Only added one entry.