Get Domains

Retrieve a list of domains associated with the client, including traffic statistics

GET /waap/v2/domains

Get Domains

cURL

curl --request GET \
  --url https://api.gcore.com/waap/v2/domains \
  --header 'Authorization: <api-key>'

200

{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "results": [
    {
      "id": 123,
      "name": "<string>",
      "custom_page_set": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "aliases": [
        "<string>"
      ],
      "stats": {
        "total_requests": 0,
        "attacks_detected": 0,
        "attacks_blocked": 0
      }
    }
  ]
}

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, total_requests, -total_requests, attacks_detected, -attacks_detected

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

Example:

"active"

name · string

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

Example:

"*example.com"

ids · integer[]

Filter domains based on their IDs

The domain ID

Examples:

1

2

3

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

List of items returned in the response following given criteria

Show child attributes