Retrieve a custom page set

Retrieve a custom page set based on the provided ID

GET /waap/v1/custom-page-sets/{set_id}

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.get(
    0,
)
print(waap_custom_page_set.id)

package main

import (
	"context"
	"fmt"

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

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

curl --request GET \
  --url https://api.gcore.com/waap/v1/custom-page-sets/{set_id} \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.gcore.com/waap/v1/custom-page-sets/{set_id}', 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/{set_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://api.gcore.com/waap/v1/custom-page-sets/{set_id}")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

200

{
  "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

Path Parameters

set_id · integer · required

The ID of the custom page set

Response

200

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