Custom Pages
custom_pages
Methods
Get A Custom Page -> Envelope<{ id, created_on, description, 5 more... }>
get/{accounts_or_zones}/{account_or_zone_id}/custom_pages/{identifier}
Fetches the details of a custom page.
List Custom Pages -> SinglePage<{ id, created_on, description, 5 more... }>
get/{accounts_or_zones}/{account_or_zone_id}/custom_pages
Fetches all the custom pages.
Update A Custom Page -> Envelope<{ id, created_on, description, 5 more... }>
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
path Parameters
identifier:
Error Page Types
"waf_block"
"ip_block"
"country_challenge"
"500_errors"
"1000_errors"
"managed_challenge"
"ratelimit_block"
account_id: string
Optional
The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
zone_id: string
Optional
The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
Response fields
errors: Array<{ code, message, documentation_url, 1 more... }>
messages: Array<{ code, message, documentation_url, 1 more... }>
success: true
Whether the API call was successful.
result: { id, created_on, description, 5 more... }
Optional
Request example
200Example