Create a custom page set

Create a custom page set based on the provided data. For any custom page type (block, block_csrf, etc) that is not provided the default page will be used.

POST /waap/v1/custom-page-sets

Python

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
waap_custom_page_set = client.waap.custom_page_sets.create(
    name="x",
)
print(waap_custom_page_set.id)

package main

import (
	"context"
	"fmt"

	"github.com/G-Core/gcore-go"
	"github.com/G-Core/gcore-go/option"
	"github.com/G-Core/gcore-go/waap"
)

func main() {
	client := gcore.NewClient(
		option.WithAPIKey("My API Key"),
	)
	waapCustomPageSet, err := client.Waap.CustomPageSets.New(context.TODO(), waap.CustomPageSetNewParams{
		Name: "x",
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", waapCustomPageSet.ID)
}

curl --request POST \
  --url https://api.gcore.com/waap/v1/custom-page-sets \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "domains": [
    123
  ],
  "block": {
    "enabled": true,
    "logo": "<string>",
    "header": "<string>",
    "title": "<string>",
    "text": "<string>"
  },
  "block_csrf": {
    "enabled": true,
    "logo": "<string>",
    "header": "<string>",
    "title": "<string>",
    "text": "<string>"
  },
  "captcha": {
    "enabled": true,
    "logo": "<string>",
    "header": "<string>",
    "title": "<string>",
    "text": "<string>",
    "error": "<string>"
  },
  "cookie_disabled": {
    "enabled": true,
    "header": "<string>",
    "text": "<string>"
  },
  "handshake": {
    "enabled": true,
    "logo": "<string>",
    "header": "<string>",
    "title": "<string>"
  },
  "javascript_disabled": {
    "enabled": true,
    "header": "<string>",
    "text": "<string>"
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    domains: [123],
    block: {
      enabled: true,
      logo: '<string>',
      header: '<string>',
      title: '<string>',
      text: '<string>'
    },
    block_csrf: {
      enabled: true,
      logo: '<string>',
      header: '<string>',
      title: '<string>',
      text: '<string>'
    },
    captcha: {
      enabled: true,
      logo: '<string>',
      header: '<string>',
      title: '<string>',
      text: '<string>',
      error: '<string>'
    },
    cookie_disabled: {enabled: true, header: '<string>', text: '<string>'},
    handshake: {enabled: true, logo: '<string>', header: '<string>', title: '<string>'},
    javascript_disabled: {enabled: true, header: '<string>', text: '<string>'}
  })
};

fetch('https://api.gcore.com/waap/v1/custom-page-sets', 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/custom-page-sets",
  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([
    'name' => '<string>',
    'domains' => [
        123
    ],
    'block' => [
        'enabled' => true,
        'logo' => '<string>',
        'header' => '<string>',
        'title' => '<string>',
        'text' => '<string>'
    ],
    'block_csrf' => [
        'enabled' => true,
        'logo' => '<string>',
        'header' => '<string>',
        'title' => '<string>',
        'text' => '<string>'
    ],
    'captcha' => [
        'enabled' => true,
        'logo' => '<string>',
        'header' => '<string>',
        'title' => '<string>',
        'text' => '<string>',
        'error' => '<string>'
    ],
    'cookie_disabled' => [
        'enabled' => true,
        'header' => '<string>',
        'text' => '<string>'
    ],
    'handshake' => [
        'enabled' => true,
        'logo' => '<string>',
        'header' => '<string>',
        'title' => '<string>'
    ],
    'javascript_disabled' => [
        'enabled' => true,
        'header' => '<string>',
        'text' => '<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;
}

HttpResponse<String> response = Unirest.post("https://api.gcore.com/waap/v1/custom-page-sets")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"domains\": [\n    123\n  ],\n  \"block\": {\n    \"enabled\": true,\n    \"logo\": \"<string>\",\n    \"header\": \"<string>\",\n    \"title\": \"<string>\",\n    \"text\": \"<string>\"\n  },\n  \"block_csrf\": {\n    \"enabled\": true,\n    \"logo\": \"<string>\",\n    \"header\": \"<string>\",\n    \"title\": \"<string>\",\n    \"text\": \"<string>\"\n  },\n  \"captcha\": {\n    \"enabled\": true,\n    \"logo\": \"<string>\",\n    \"header\": \"<string>\",\n    \"title\": \"<string>\",\n    \"text\": \"<string>\",\n    \"error\": \"<string>\"\n  },\n  \"cookie_disabled\": {\n    \"enabled\": true,\n    \"header\": \"<string>\",\n    \"text\": \"<string>\"\n  },\n  \"handshake\": {\n    \"enabled\": true,\n    \"logo\": \"<string>\",\n    \"header\": \"<string>\",\n    \"title\": \"<string>\"\n  },\n  \"javascript_disabled\": {\n    \"enabled\": true,\n    \"header\": \"<string>\",\n    \"text\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/waap/v1/custom-page-sets")

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  \"name\": \"<string>\",\n  \"domains\": [\n    123\n  ],\n  \"block\": {\n    \"enabled\": true,\n    \"logo\": \"<string>\",\n    \"header\": \"<string>\",\n    \"title\": \"<string>\",\n    \"text\": \"<string>\"\n  },\n  \"block_csrf\": {\n    \"enabled\": true,\n    \"logo\": \"<string>\",\n    \"header\": \"<string>\",\n    \"title\": \"<string>\",\n    \"text\": \"<string>\"\n  },\n  \"captcha\": {\n    \"enabled\": true,\n    \"logo\": \"<string>\",\n    \"header\": \"<string>\",\n    \"title\": \"<string>\",\n    \"text\": \"<string>\",\n    \"error\": \"<string>\"\n  },\n  \"cookie_disabled\": {\n    \"enabled\": true,\n    \"header\": \"<string>\",\n    \"text\": \"<string>\"\n  },\n  \"handshake\": {\n    \"enabled\": true,\n    \"logo\": \"<string>\",\n    \"header\": \"<string>\",\n    \"title\": \"<string>\"\n  },\n  \"javascript_disabled\": {\n    \"enabled\": true,\n    \"header\": \"<string>\",\n    \"text\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

201

{
  "name": "<string>",
  "id": 123,
  "domains": [
    123
  ],
  "block": {
    "enabled": true,
    "logo": "<string>",
    "header": "<string>",
    "title": "<string>",
    "text": "<string>"
  },
  "block_csrf": {
    "enabled": true,
    "logo": "<string>",
    "header": "<string>",
    "title": "<string>",
    "text": "<string>"
  },
  "captcha": {
    "enabled": true,
    "logo": "<string>",
    "header": "<string>",
    "title": "<string>",
    "text": "<string>",
    "error": "<string>"
  },
  "cookie_disabled": {
    "enabled": true,
    "header": "<string>",
    "text": "<string>"
  },
  "handshake": {
    "enabled": true,
    "logo": "<string>",
    "header": "<string>",
    "title": "<string>"
  },
  "javascript_disabled": {
    "enabled": true,
    "header": "<string>",
    "text": "<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

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

Body

application/json

Create a custom page set

name · string · required

Name of the custom page set

Required string length: 1 - 50

domains · integer[] | null

List of domain IDs that are associated with this page set

The domain ID

block · BlockPageData · object | null

Show child attributes

block_csrf · BlockCsrfPageData · object | null

Show child attributes

captcha · CaptchaPageData · object | null

Show child attributes

cookie_disabled · CookieDisabledPageData · object | null

Show child attributes

handshake · HandshakePageData · object | null

Show child attributes

javascript_disabled · JavascriptDisabledPageData · object | null

Show child attributes

Response

201

application/json

Successful Response

name · string · required

Name of the custom page set

Required string length: 1 - 50

id · integer · required

The ID of the custom page set

domains · integer[] | null

List of domain IDs that are associated with this page set

The domain ID

block · BlockPageData · object | null

Show child attributes

block_csrf · BlockCsrfPageData · object | null

Show child attributes

captcha · CaptchaPageData · object | null

Show child attributes

cookie_disabled · CookieDisabledPageData · object | null

Show child attributes

handshake · HandshakePageData · object | null

Show child attributes

javascript_disabled · JavascriptDisabledPageData · object | null

Show child attributes