API Reference

Zero Trust

Access

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Custom Pages

List custom pages

GET/accounts/{account_id}/access/custom_pages

Get a custom page

GET/accounts/{account_id}/access/custom_pages/{custom_page_id}

Create a custom page

POST/accounts/{account_id}/access/custom_pages

Update a custom page

PUT/accounts/{account_id}/access/custom_pages/{custom_page_id}

Delete a custom page

DELETE/accounts/{account_id}/access/custom_pages/{custom_page_id}

ModelsExpand Collapse

CustomPage object { custom_html, name, type, 2 more }

custom_html: string

Custom page HTML.

name: string

Custom page name.

type: "identity_denied" or "forbidden" or "login" or "interstitial"

Custom page type.

One of the following:

"identity_denied"

"forbidden"

"login"

"interstitial"

contract_version: optional number

Contract version of the page’s Liquid template. Present (>= 1) marks a sanitized template; absent or 0 marks a legacy page served verbatim.

uid: optional string

UUID.

maxLength36

CustomPageWithoutHTML object { name, type, contract_version, 2 more }

name: string

Custom page name.

type: "identity_denied" or "forbidden" or "login" or "interstitial"

Custom page type.

One of the following:

"identity_denied"

"forbidden"

"login"

"interstitial"

contract_version: optional number

Contract version of the page’s Liquid template. Present (>= 1) marks a sanitized template; absent or 0 marks a legacy page served verbatim.

uid: optional string

UUID.

maxLength36

warnings: optional array of object { message, tier, ref }

Advisory validation findings returned when creating or updating a template. Omitted when empty.

message: string

Human-readable description of the finding.

tier: string

The validation tier that produced the finding (e.g. html, liquid).

ref: optional string

Optional pointer to the part of the template the finding refers to.

CustomPageDeleteResponse object { id }

id: optional string

UUID.

maxLength36