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

Create an insight silence

cURL

curl --request POST \
  --url https://api.gcore.com/waap/v1/domains/{domain_id}/insight-silences \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "insight_type": "<string>",
  "labels": {},
  "comment": "<string>",
  "author": "<string>",
  "expire_at": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.gcore.com/waap/v1/domains/{domain_id}/insight-silences"

payload = {
    "insight_type": "<string>",
    "labels": {},
    "comment": "<string>",
    "author": "<string>",
    "expire_at": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    insight_type: '<string>',
    labels: {},
    comment: '<string>',
    author: '<string>',
    expire_at: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.gcore.com/waap/v1/domains/{domain_id}/insight-silences', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gcore.com/waap/v1/domains/{domain_id}/insight-silences",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'insight_type' => '<string>',
    'labels' => [
        
    ],
    'comment' => '<string>',
    'author' => '<string>',
    'expire_at' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gcore.com/waap/v1/domains/{domain_id}/insight-silences"

	payload := strings.NewReader("{\n  \"insight_type\": \"<string>\",\n  \"labels\": {},\n  \"comment\": \"<string>\",\n  \"author\": \"<string>\",\n  \"expire_at\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.gcore.com/waap/v1/domains/{domain_id}/insight-silences")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"insight_type\": \"<string>\",\n  \"labels\": {},\n  \"comment\": \"<string>\",\n  \"author\": \"<string>\",\n  \"expire_at\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/waap/v1/domains/{domain_id}/insight-silences")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"insight_type\": \"<string>\",\n  \"labels\": {},\n  \"comment\": \"<string>\",\n  \"author\": \"<string>\",\n  \"expire_at\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

201

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "insight_type": "<string>",
  "labels": {},
  "comment": "<string>",
  "author": "<string>",
  "expire_at": "2023-11-07T05:31:56Z"
}

{
  "type": "http-bad-request",
  "title": "Bad Request",
  "status": 400,
  "detail": "Invalid domain name: ''''"
}

{
  "detail": "Auth token is missing or invalid"
}

{
  "detail": "Permission denied"
}

{
  "type": "http-not-found",
  "title": "Not Found",
  "status": 404,
  "detail": "The resource is not found"
}

{
  "type": "request-validation-failed",
  "title": "Request validation error.",
  "status": 422,
  "detail": "One or more fields have validation errors.",
  "errors": [
    {
      "loc": [
        "body",
        "name"
      ],
      "detail": "Input should be a valid string"
    },
    {
      "loc": [
        "body",
        "date"
      ],
      "detail": "Field required"
    },
    {
      "loc": [
        "query",
        "limit"
      ],
      "detail": "Field required"
    }
  ]
}

{
  "type": "internal-server-error",
  "title": "Internal server error.",
  "status": 500,
  "detail": "An unexpected condition was encountered which prevented the server from fulfilling the request."
}

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