Skip to content
Cloudflare API
Start here
API Reference
Custom Pages

Get a custom page

client.customPages.get("1000_errors" | "500_errors" | "basic_challenge" | 7 moreidentifier, CustomPageGetParams { account_id, zone_id } params?, RequestOptionsoptions?): CustomPageGetResponse { id, created_on, description, 5 more }
GET/{accounts_or_zones}/{account_or_zone_id}/custom_pages/{identifier}

Fetches the details of a custom page.

Security

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)
Zero Trust: PII ReadAccount Custom Pages WriteAccount Custom Pages ReadAccount Settings WriteAccount Settings Read
ParametersExpand Collapse
identifier: "1000_errors" | "500_errors" | "basic_challenge" | 7 more

Error Page Types

One of the following:
"1000_errors"
"500_errors"
"basic_challenge"
"country_challenge"
"ip_block"
"managed_challenge"
"ratelimit_block"
"under_attack"
"waf_block"
"waf_challenge"
params: CustomPageGetParams { account_id, zone_id }
account_id?: string

The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.

zone_id?: string

The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

ReturnsExpand Collapse
CustomPageGetResponse { id, created_on, description, 5 more }
id?: string
created_on?: string
formatdate-time
description?: string
modified_on?: string
formatdate-time
preview_target?: string
required_tokens?: Array<string>
state?: "default" | "customized"

The custom page state.

One of the following:
"default"
"customized"
url?: string

The URL associated with the custom page.

formaturi

Get a custom page

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiEmail: process.env['CLOUDFLARE_EMAIL'], // This is the default and can be omitted
  apiKey: process.env['CLOUDFLARE_API_KEY'], // This is the default and can be omitted
});

const customPage = await client.customPages.get('ratelimit_block', { account_id: 'account_id' });

console.log(customPage.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": "basic_challenge",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "description": "Basic Challenge",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "preview_target": "block:basic-sec-captcha",
    "required_tokens": [
      "::CAPTCHA_BOX::"
    ],
    "state": "default",
    "url": "http://www.example.com"
  }
}
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": "basic_challenge",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "description": "Basic Challenge",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "preview_target": "block:basic-sec-captcha",
    "required_tokens": [
      "::CAPTCHA_BOX::"
    ],
    "state": "default",
    "url": "http://www.example.com"
  }
}