Skip to main content
POST
Preview a custom page

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Query Parameters

page_type
enum<string>
required

The type of the custom page

Available options:
block.html,
block_csrf.html,
captcha.html,
cookieDisabled.html,
handshake.html,
javascriptDisabled.html

Body

application/json
logo
string | null

Supported image types are JPEG, PNG and JPG, size is limited to width 450px, height 130px. This should be a base 64 encoding of the full HTML img tag compatible image, with the header included.

header
string | null

The text to display in the header of the custom page

Required string length: 3 - 62
title
string | null

The text to display in the title of the custom page

Required string length: 3 - 50
text
string | null

The text to display in the body of the custom page

Required string length: 20 - 400
error
string | null

Error message

Required string length: 10 - 400

Response

Successful Response

html
string
required

HTML content of the custom page