Get Custom Error Responses

GET

https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/phases/http_custom_errors/entrypoint

Last modified:2022-12-16 13:48:32

Fetches all Custom Error Responses in a zone.

Request

Path Params

zone_id

string

required

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.cloudflare.com/client/v4/zones//rulesets/phases/http_custom_errors/entrypoint'

Responses

🟢200Get Custom Error Responses response

application/json

Body

description

optional

Example:

optional

Example:

2f2feab2026849078ba485f918791bdc

kind

optional

Example:

zone

name

optional

Example:

default

phase

optional

Example:

http_custom_errors

rules

array[object (custom-error-responses_components-schemas-rule) {6}]

optional

The rules in the ruleset.

action

optional

Example:

serve_error

action_parameters

object (action_parameters_serve_error)

optional

The action parameters for the serve_error action.

description

optional

Example:

Change error response based on geolocation

expression

optional

Example:

ip.geoip.country eq "AL"

optional

Example:

3a03d665bac047339bb530ecb439a90d

version

optional

Example:

Example

{
    "description": "",
    "id": "2f2feab2026849078ba485f918791bdc",
    "kind": "zone",
    "name": "default",
    "phase": "http_custom_errors",
    "rules": [
        {
            "action": "serve_error",
            "action_parameters": {
                "content": "some html error page",
                "content_type": "text/html",
                "status_code": 530
            },
            "description": "Change error response based on geolocation",
            "expression": "ip.geoip.country eq \"AL\"",
            "id": "3a03d665bac047339bb530ecb439a90d",
            "version": "1"
        }
    ]
}

🟢200Get Custom Error Responses response failure

Modified at 2022-12-16 13:48:32

Update Config Rules

Update Custom Error Responses