Skip to content
Cloudflare API
Start here
API Reference

Custom Pages

List custom pages
client.customPages.list(CustomPageListParams { account_id, zone_id } params?, RequestOptionsoptions?): SinglePage<CustomPageListResponse { id, created_on, description, 5 more } >
GET/{accounts_or_zones}/{account_or_zone_id}/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}
Update a custom page
client.customPages.update("1000_errors" | "500_errors" | "basic_challenge" | 7 moreidentifier, CustomPageUpdateParams { state, url, account_id, zone_id } params, RequestOptionsoptions?): CustomPageUpdateResponse { id, created_on, description, 5 more }
PUT/{accounts_or_zones}/{account_or_zone_id}/custom_pages/{identifier}
ModelsExpand Collapse
CustomPageListResponse { 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
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
CustomPageUpdateResponse { 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