Retrieve a list of insights

Retrieve a list of insights for a specific domain.

GET /waap/v1/domains/{domain_id}/insights

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.domains.insights.list(
    domain_id=1,
)
page = page.results[0]
print(page.id)

200

{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "insight_type": "<string>",
      "labels": {},
      "first_seen": "2023-11-07T05:31:56Z",
      "last_seen": "2023-11-07T05:31:56Z",
      "last_status_change": "2023-11-07T05:31:56Z",
      "description": "A request originated from a high-risk IP: 1.2.3.4, but it was allowed by rule: 'my custom rule' the description of the insight",
      "recommendation": "disable or delete rule \"my-custom-rule\""
    }
  ]
}

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

domain_id · integer · required

The domain ID

Query Parameters

ordering · enum<string> · default: -last_seen

Sort the response by given field.

Available options: id, -id, insight_type, -insight_type, first_seen, -first_seen, last_seen, -last_seen, last_status_change, -last_status_change, status, -status

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

id · string<uuid>[] | null

The ID of the insight

insight_type · string[] | null

The type of the insight

status · enum<string>[] | null

The status of the insight

The different statuses an insight can have

Available options: OPEN, ACKED, CLOSED

description · string | null

The description of the insight. Supports '*' as a wildcard.

Maximum string length: 450

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

List of items returned in the response following given criteria

Show child attributes