Preview a custom page
curl --request POST \
--url https://api.gcore.com/waap/v1/preview-custom-page \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"logo": "<string>",
"header": "<string>",
"title": "<string>",
"text": "<string>",
"error": "<string>"
}
'import requests
url = "https://api.gcore.com/waap/v1/preview-custom-page"
payload = {
"logo": "<string>",
"header": "<string>",
"title": "<string>",
"text": "<string>",
"error": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
logo: '<string>',
header: '<string>',
title: '<string>',
text: '<string>',
error: '<string>'
})
};
fetch('https://api.gcore.com/waap/v1/preview-custom-page', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gcore.com/waap/v1/preview-custom-page",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'logo' => '<string>',
'header' => '<string>',
'title' => '<string>',
'text' => '<string>',
'error' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.gcore.com/waap/v1/preview-custom-page"
payload := strings.NewReader("{\n \"logo\": \"<string>\",\n \"header\": \"<string>\",\n \"title\": \"<string>\",\n \"text\": \"<string>\",\n \"error\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.gcore.com/waap/v1/preview-custom-page")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"logo\": \"<string>\",\n \"header\": \"<string>\",\n \"title\": \"<string>\",\n \"text\": \"<string>\",\n \"error\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gcore.com/waap/v1/preview-custom-page")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"logo\": \"<string>\",\n \"header\": \"<string>\",\n \"title\": \"<string>\",\n \"text\": \"<string>\",\n \"error\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"html": "<string>"
}{
"type": "http-bad-request",
"title": "Bad Request",
"status": 400,
"detail": "Invalid domain name: ''''"
}{
"detail": "Auth token is missing or invalid"
}{
"detail": "Permission denied"
}{
"type": "http-not-found",
"title": "Not Found",
"status": 404,
"detail": "The resource is not found"
}{
"type": "request-validation-failed",
"title": "Request validation error.",
"status": 422,
"detail": "One or more fields have validation errors.",
"errors": [
{
"loc": [
"body",
"name"
],
"detail": "Input should be a valid string"
},
{
"loc": [
"body",
"date"
],
"detail": "Field required"
},
{
"loc": [
"query",
"limit"
],
"detail": "Field required"
}
]
}{
"type": "internal-server-error",
"title": "Internal server error.",
"status": 500,
"detail": "An unexpected condition was encountered which prevented the server from fulfilling the request."
}Custom Page Sets
Preview a custom page
Allows to preview a custom page without creating it based on the provided type and data
POST
/
waap
/
v1
/
preview-custom-page
Preview a custom page
curl --request POST \
--url https://api.gcore.com/waap/v1/preview-custom-page \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"logo": "<string>",
"header": "<string>",
"title": "<string>",
"text": "<string>",
"error": "<string>"
}
'import requests
url = "https://api.gcore.com/waap/v1/preview-custom-page"
payload = {
"logo": "<string>",
"header": "<string>",
"title": "<string>",
"text": "<string>",
"error": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
logo: '<string>',
header: '<string>',
title: '<string>',
text: '<string>',
error: '<string>'
})
};
fetch('https://api.gcore.com/waap/v1/preview-custom-page', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gcore.com/waap/v1/preview-custom-page",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'logo' => '<string>',
'header' => '<string>',
'title' => '<string>',
'text' => '<string>',
'error' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.gcore.com/waap/v1/preview-custom-page"
payload := strings.NewReader("{\n \"logo\": \"<string>\",\n \"header\": \"<string>\",\n \"title\": \"<string>\",\n \"text\": \"<string>\",\n \"error\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.gcore.com/waap/v1/preview-custom-page")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"logo\": \"<string>\",\n \"header\": \"<string>\",\n \"title\": \"<string>\",\n \"text\": \"<string>\",\n \"error\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gcore.com/waap/v1/preview-custom-page")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"logo\": \"<string>\",\n \"header\": \"<string>\",\n \"title\": \"<string>\",\n \"text\": \"<string>\",\n \"error\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"html": "<string>"
}{
"type": "http-bad-request",
"title": "Bad Request",
"status": 400,
"detail": "Invalid domain name: ''''"
}{
"detail": "Auth token is missing or invalid"
}{
"detail": "Permission denied"
}{
"type": "http-not-found",
"title": "Not Found",
"status": 404,
"detail": "The resource is not found"
}{
"type": "request-validation-failed",
"title": "Request validation error.",
"status": 422,
"detail": "One or more fields have validation errors.",
"errors": [
{
"loc": [
"body",
"name"
],
"detail": "Input should be a valid string"
},
{
"loc": [
"body",
"date"
],
"detail": "Field required"
},
{
"loc": [
"query",
"limit"
],
"detail": "Field required"
}
]
}{
"type": "internal-server-error",
"title": "Internal server error.",
"status": 500,
"detail": "An unexpected condition was encountered which prevented the server from fulfilling the request."
}Authorizations
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
The type of the custom page
Available options:
block.html, block_csrf.html, captcha.html, cookieDisabled.html, handshake.html, javascriptDisabled.html Body
application/json
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.
The text to display in the header of the custom page
Required string length:
3 - 62The text to display in the title of the custom page
Required string length:
3 - 50The text to display in the body of the custom page
Required string length:
20 - 400Error message
Required string length:
10 - 400Response
Successful Response
HTML content of the custom page
Was this page helpful?
⌘I