Cloudflare API | Custom Pages › update

API Reference

Account & User Management

Resource Sharing

List custom pages

Get a custom page

Update a custom page

AI

Certificate Management

Certificate Authorities

Client Certificates

Custom Certificates

Custom Hostnames

Keyless Certificates

MTLS Certificates

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

Cloudflare One

DNS

Account Custom Nameservers

Domain/Zone Management

IP Addresses

Media

Networking

Magic Cloud Networking

Magic Network Monitoring

Network Interconnects

Observability

Security Center

Radar

Routing & Performance

Rules

Cloud Connector

Managed Transforms

URL Normalization

Security

Schema Validation

Content Scanning

Leaked Credential Checks

Token Validation

Storage & Databases

R2 Data Catalog

Threat Intelligence

Brand Protection

Workers & Pages

Browser Rendering

Durable Objects

Workers For Platforms

Shared

Custom Pages

CustomPages

Methods

client.customPages.list(, ):

<

CustomPageListResponse

>

get/{accounts_or_zones}/{account_or_zone_id}/custom_pages

Fetches all the custom pages.

client.customPages.get(, , ):

CustomPageGetResponse

get/{accounts_or_zones}/{account_or_zone_id}/custom_pages/{identifier}

Fetches the details of a custom page.

client.customPages.update(, , ):

CustomPageUpdateResponse

put/{accounts_or_zones}/{account_or_zone_id}/custom_pages/{identifier}

Updates the configuration of an existing 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)

Account Custom Pages Write Account Settings Write

Parameters

identifier: "1000_errors" | "500_errors" | "basic_challenge" | 7 more...

Error Page Types

"1000_errors"

"500_errors"

"basic_challenge"

"country_challenge"

"ip_block"

"managed_challenge"

"ratelimit_block"

"under_attack"

"waf_block"

"waf_challenge"

params:

CustomPageUpdateParams

state: "default" | "customized"

Body param: The custom page state.

url: string

(format: uri)

Body param: The URL associated with the custom page.

account_id?: string

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

zone_id?: string

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

Returns

CustomPageUpdateResponse{

id?: string

created_on?: string

(format: date-time)

description?: string

modified_on?: string

(format: date-time)

preview_target?: string

required_tokens?: Array<string>

state?: "default" | "customized"

The custom page state.

url?: string

(format: uri)

The URL associated with the custom page.

Request example

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.update('ratelimit_block', {
  state: 'default',
  url: 'http://www.example.com',
  account_id: 'account_id',
});

console.log(customPage.id);

200Example

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