Create an insight silence

Create a new insight silence for a specified domain. Insight silences help in temporarily disabling certain insights based on specific criteria.

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

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
)
waap_insight_silence = client.waap.domains.insight_silences.create(
    domain_id=1,
    author="author",
    comment="comment",
    insight_type="26f1klzn5713-56bincal4ca-60zz1k91s4",
    labels={
        "foo": "string"
    },
)
print(waap_insight_silence.id)

201

{
  "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

Body

application/json

insight_type · string · required

The slug of the insight type

Maximum string length: 64

Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

labels · Labels · object · required

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

Show child attributes

comment · string · required

A comment explaining the reason for the silence

Maximum string length: 180

author · string · required

The author of the silence

Maximum string length: 180

expire_at · string<date-time> | null

The date and time the silence expires in ISO 8601 format

Response

201

application/json

Successful Response

id · string<uuid> · required

A generated unique identifier for the silence

insight_type · string · required

The slug of the insight type

labels · Labels · object · required

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

Show child attributes

comment · string · required

A comment explaining the reason for the silence

author · string · required

The author of the silence

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

The date and time the silence expires in ISO 8601 format