Retrieve a list of insight silences

Retrieve a list of insight silences for a specific domain

GET /waap/v1/domains/{domain_id}/insight-silences

Try it

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.insight_silences.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": {},
      "comment": "<string>",
      "author": "<string>",
      "expire_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

Path Parameters

domain_id · integer · required

The domain ID

Query Parameters

ordering · enum<string> · default: -id

Sort the response by given field.

Available options: id, -id, insight_type, -insight_type, comment, -comment, author, -author, expire_at, -expire_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

id · string<uuid>[] | null

The ID of the insight silence

insight_type · string[] | null

The type of the insight silence

comment · string | null

The comment of the insight silence

author · string | null

The author of the insight silence

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

List of items returned in the response following given criteria

Show child attributes

results. id · string<uuid> · required

A generated unique identifier for the silence

results. insight_type · string · required

The slug of the insight type

results. labels · Labels · object · required

A hash table of label names and values that apply to the insight silence

Show child attributes

results.labels. {key} · string

results. comment · string · required

A comment explaining the reason for the silence

results. author · string · required

The author of the silence

results. expire_at · string<date-time> | null · required

The date and time the silence expires in ISO 8601 format