Retrieve custom page sets available for use

Retrieve a list of custom page sets available for use

GET /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
)
page = client.waap.custom_page_sets.list()
page = page.results[0]
print(page.id)

200

{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "results": [
    {
      "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

Query Parameters

ordering · enum<string>

Sort the response by given field.

Available options: name, -name, id, -id

limit · integer · default: 100

Number of items to return

Required range: 0 <= x <= 100

offset · integer · default: 0

Number of items to skip

Required range: 0 <= x <= 100000

name · string

Filter page sets based on their name. Supports '*' as a wildcard character

Example:

"*example"

ids · integer[]

Filter page sets based on their IDs

Response

200

application/json

Successful Response

limit · integer · required

Number of items requested in the response

offset · integer · required

Items response offset used

count · integer · required

Number of items contain in the response

results · CustomPageSetResponse · object[] · required

List of items returned in the response following given criteria

Show child attributes