GET
/
waap
/
v1
/
domains
Python
from gcore import Gcore

client = Gcore(
    api_key="My API Key",
)
page = client.waap.domains.list()
page = page.results[0]
print(page.id)
{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "results": [
    {
      "id": 123,
      "name": "<string>",
      "status": "active",
      "custom_page_set": 123,
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

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:
id,
name,
status,
created_at,
-id,
-name,
-status,
-created_at
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
status
enum<string>

Filter domains based on the domain status

Available options:
active,
bypass,
monitor,
locked
name
string

Filter domains based on the domain name. Supports '*' as a wildcard character

Examples:

"*example.com"

ids
integer[]

Filter domains based on their IDs

The domain ID

Response

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
SummaryDomainResponse · object[]
required

List of items returned in the response following given criteria