API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

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

Custom PagesAssets

List custom assets

client.customPages.assets.list(AssetListParams { account_id, zone_id, page, per_page } params?, RequestOptionsoptions?): V4PagePaginationArray<AssetListResponse { description, last_updated, name, 2 more } >

GET/{accounts_or_zones}/{account_or_zone_id}/custom_pages/assets

Get a custom asset

client.customPages.assets.get(stringassetName, AssetGetParams { account_id, zone_id } params?, RequestOptionsoptions?): AssetGetResponse { description, last_updated, name, 2 more }

GET/{accounts_or_zones}/{account_or_zone_id}/custom_pages/assets/{asset_name}

Create a custom asset

client.customPages.assets.create(AssetCreateParams { description, name, url, 2 more } params, RequestOptionsoptions?): AssetCreateResponse { description, last_updated, name, 2 more }

POST/{accounts_or_zones}/{account_or_zone_id}/custom_pages/assets

Update a custom asset

client.customPages.assets.update(stringassetName, AssetUpdateParams { description, url, account_id, zone_id } params, RequestOptionsoptions?): AssetUpdateResponse { description, last_updated, name, 2 more }

PUT/{accounts_or_zones}/{account_or_zone_id}/custom_pages/assets/{asset_name}

Delete a custom asset

client.customPages.assets.delete(stringassetName, AssetDeleteParams { account_id, zone_id } params?, RequestOptionsoptions?): void

DELETE/{accounts_or_zones}/{account_or_zone_id}/custom_pages/assets/{asset_name}

ModelsExpand Collapse

AssetListResponse { description, last_updated, name, 2 more }

description?: string

A short description of the custom asset.

last_updated?: string

formatdate-time

name?: string

The unique name of the custom asset. Can only contain letters (A-Z, a-z), numbers (0-9), and underscores (_).

minLength1

size_bytes?: number

The size of the asset content in bytes.

url?: string

The URL where the asset content is fetched from.

formaturi

AssetGetResponse { description, last_updated, name, 2 more }

description?: string

A short description of the custom asset.

last_updated?: string

formatdate-time

name?: string

The unique name of the custom asset. Can only contain letters (A-Z, a-z), numbers (0-9), and underscores (_).

minLength1

size_bytes?: number

The size of the asset content in bytes.

url?: string

The URL where the asset content is fetched from.

formaturi

AssetCreateResponse { description, last_updated, name, 2 more }

description?: string

A short description of the custom asset.

last_updated?: string

formatdate-time

name?: string

The unique name of the custom asset. Can only contain letters (A-Z, a-z), numbers (0-9), and underscores (_).

minLength1

size_bytes?: number

The size of the asset content in bytes.

url?: string

The URL where the asset content is fetched from.

formaturi

AssetUpdateResponse { description, last_updated, name, 2 more }

description?: string

A short description of the custom asset.

last_updated?: string

formatdate-time

name?: string

The unique name of the custom asset. Can only contain letters (A-Z, a-z), numbers (0-9), and underscores (_).

minLength1

size_bytes?: number

The size of the asset content in bytes.

url?: string

The URL where the asset content is fetched from.

formaturi