Skip to content
Cloudflare API
Start here
API Reference

Custom Pages

List custom pages
custom_pages.list(CustomPageListParams**kwargs) -> SyncSinglePage[CustomPageListResponse]
GET/{accounts_or_zones}/{account_or_zone_id}/custom_pages
Get a custom page
custom_pages.get(Literal["1000_errors", "500_errors", "basic_challenge", 7 more]identifier, CustomPageGetParams**kwargs) -> CustomPageGetResponse
GET/{accounts_or_zones}/{account_or_zone_id}/custom_pages/{identifier}
Update a custom page
custom_pages.update(Literal["1000_errors", "500_errors", "basic_challenge", 7 more]identifier, CustomPageUpdateParams**kwargs) -> CustomPageUpdateResponse
PUT/{accounts_or_zones}/{account_or_zone_id}/custom_pages/{identifier}
ModelsExpand Collapse
class CustomPageListResponse: …
id: Optional[str]
created_on: Optional[datetime]
formatdate-time
description: Optional[str]
modified_on: Optional[datetime]
formatdate-time
preview_target: Optional[str]
required_tokens: Optional[List[str]]
state: Optional[Literal["default", "customized"]]

The custom page state.

One of the following:
"default"
"customized"
url: Optional[str]

The URL associated with the custom page.

formaturi
class CustomPageGetResponse: …
id: Optional[str]
created_on: Optional[datetime]
formatdate-time
description: Optional[str]
modified_on: Optional[datetime]
formatdate-time
preview_target: Optional[str]
required_tokens: Optional[List[str]]
state: Optional[Literal["default", "customized"]]

The custom page state.

One of the following:
"default"
"customized"
url: Optional[str]

The URL associated with the custom page.

formaturi
class CustomPageUpdateResponse: …
id: Optional[str]
created_on: Optional[datetime]
formatdate-time
description: Optional[str]
modified_on: Optional[datetime]
formatdate-time
preview_target: Optional[str]
required_tokens: Optional[List[str]]
state: Optional[Literal["default", "customized"]]

The custom page state.

One of the following:
"default"
"customized"
url: Optional[str]

The URL associated with the custom page.

formaturi

Custom PagesAssets

List custom assets
custom_pages.assets.list(AssetListParams**kwargs) -> SyncV4PagePaginationArray[AssetListResponse]
GET/{accounts_or_zones}/{account_or_zone_id}/custom_pages/assets
Get a custom asset
custom_pages.assets.get(strasset_name, AssetGetParams**kwargs) -> AssetGetResponse
GET/{accounts_or_zones}/{account_or_zone_id}/custom_pages/assets/{asset_name}
Create a custom asset
custom_pages.assets.create(AssetCreateParams**kwargs) -> AssetCreateResponse
POST/{accounts_or_zones}/{account_or_zone_id}/custom_pages/assets
Update a custom asset
custom_pages.assets.update(strasset_name, AssetUpdateParams**kwargs) -> AssetUpdateResponse
PUT/{accounts_or_zones}/{account_or_zone_id}/custom_pages/assets/{asset_name}
Delete a custom asset
custom_pages.assets.delete(strasset_name, AssetDeleteParams**kwargs)
DELETE/{accounts_or_zones}/{account_or_zone_id}/custom_pages/assets/{asset_name}
ModelsExpand Collapse
class AssetListResponse: …
description: Optional[str]

A short description of the custom asset.

last_updated: Optional[datetime]
formatdate-time
name: Optional[str]

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

minLength1
size_bytes: Optional[int]

The size of the asset content in bytes.

url: Optional[str]

The URL where the asset content is fetched from.

formaturi
class AssetGetResponse: …
description: Optional[str]

A short description of the custom asset.

last_updated: Optional[datetime]
formatdate-time
name: Optional[str]

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

minLength1
size_bytes: Optional[int]

The size of the asset content in bytes.

url: Optional[str]

The URL where the asset content is fetched from.

formaturi
class AssetCreateResponse: …
description: Optional[str]

A short description of the custom asset.

last_updated: Optional[datetime]
formatdate-time
name: Optional[str]

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

minLength1
size_bytes: Optional[int]

The size of the asset content in bytes.

url: Optional[str]

The URL where the asset content is fetched from.

formaturi
class AssetUpdateResponse: …
description: Optional[str]

A short description of the custom asset.

last_updated: Optional[datetime]
formatdate-time
name: Optional[str]

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

minLength1
size_bytes: Optional[int]

The size of the asset content in bytes.

url: Optional[str]

The URL where the asset content is fetched from.

formaturi