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)

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

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

Show child attributes

block_csrf · BlockCsrfPageData · object

Show child attributes

captcha · CaptchaPageData · object

Show child attributes

cookie_disabled · CookieDisabledPageData · object

Show child attributes

handshake · HandshakePageData · object

Show child attributes

javascript_disabled · JavascriptDisabledPageData · object

Show child attributes