Skip to main content
node
const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v3/alert-defs';

let options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <API_KEY>', 'content-type': 'application/json'},
  body: '{"activeOn":{"dayOfWeek":[["DAY_OF_WEEK_MONDAY_OR_UNSPECIFIED","DAY_OF_WEEK_TUESDAY"]],"endTime":{"hours":14,"minutes":30},"startTime":{"hours":14,"minutes":30}},"deleted":false,"description":"Alert description","enabled":true,"entityLabels":[{"key":"string","value":"string"}],"groupByKeys":[["key1","key2"]],"incidentsSettings":{"minutes":30,"notifyOn":"NOTIFY_ON_TRIGGERED_AND_RESOLVED"},"logsImmediate":{"logsFilter":{"simpleFilter":{"labelFilters":{"applicationName":[{"operation":"LOG_FILTER_OPERATION_TYPE_INCLUDES","value":"my-app"}],"severities":["LOG_SEVERITY_VERBOSE_UNSPECIFIED"],"subsystemName":[{"operation":"LOG_FILTER_OPERATION_TYPE_INCLUDES","value":"my-app"}]},"luceneQuery":"string"}},"notificationPayloadFilter":[["obj.field"]]},"name":"My Alert","notificationGroup":{"destinations":[{"connectorId":"connector_id_example","notifyOn":"NOTIFY_ON_TRIGGERED_AND_RESOLVED","presetId":"preset_id_example","resolvedRouteOverrides":{"configOverrides":{"connectorConfigFields":[{"fieldName":"description","template":"template_example"}],"messageConfigFields":[{"fieldName":"description","template":"template_example"}],"payloadType":"slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"}},"triggeredRoutingOverrides":{"configOverrides":{"connectorConfigFields":[{"fieldName":"description","template":"template_example"}],"messageConfigFields":[{"fieldName":"description","template":"template_example"}],"payloadType":"slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"}}}],"groupByKeys":[["key1","key2"]],"router":{"id":"123e4567-e89b-12d3-a456-426614174000","notifyOn":"NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"},"webhooks":[{"integration":{"integrationId":123},"minutes":15,"notifyOn":"NOTIFY_ON_TRIGGERED_AND_RESOLVED"}]},"notificationGroupExcess":[{"destinations":[{"connectorId":"connector_id_example","notifyOn":"NOTIFY_ON_TRIGGERED_AND_RESOLVED","presetId":"preset_id_example","resolvedRouteOverrides":{"configOverrides":{"connectorConfigFields":[{"fieldName":"description","template":"template_example"}],"messageConfigFields":[{"fieldName":"description","template":"template_example"}],"payloadType":"slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"}},"triggeredRoutingOverrides":{"configOverrides":{"connectorConfigFields":[{"fieldName":"description","template":"template_example"}],"messageConfigFields":[{"fieldName":"description","template":"template_example"}],"payloadType":"slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"}}}],"groupByKeys":[["key1","key2"]],"router":{"id":"123e4567-e89b-12d3-a456-426614174000","notifyOn":"NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"},"webhooks":[{"integration":{"integrationId":123},"minutes":15,"notifyOn":"NOTIFY_ON_TRIGGERED_AND_RESOLVED"}]}],"phantomMode":false,"priority":"ALERT_DEF_PRIORITY_P4","type":"ALERT_DEF_TYPE_METRIC_THRESHOLD"}'
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
{
  "alertDef": {
    "alertDefProperties": {
      "activeOn": {
        "dayOfWeek": [
          [
            "DAY_OF_WEEK_MONDAY_OR_UNSPECIFIED",
            "DAY_OF_WEEK_TUESDAY"
          ]
        ],
        "endTime": {
          "hours": 14,
          "minutes": 30
        },
        "startTime": {
          "hours": 14,
          "minutes": 30
        }
      },
      "deleted": false,
      "description": "Alert description",
      "enabled": true,
      "entityLabels": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "groupByKeys": [
        [
          "key1",
          "key2"
        ]
      ],
      "incidentsSettings": {
        "minutes": 30,
        "notifyOn": "NOTIFY_ON_TRIGGERED_AND_RESOLVED"
      },
      "logsImmediate": {
        "logsFilter": {
          "simpleFilter": {
            "labelFilters": {
              "applicationName": [
                "<any>"
              ],
              "severities": [
                "<any>"
              ],
              "subsystemName": [
                "<any>"
              ]
            },
            "luceneQuery": "<string>"
          }
        },
        "notificationPayloadFilter": [
          [
            "obj.field"
          ]
        ]
      },
      "name": "My Alert",
      "notificationGroup": {
        "destinations": [
          {
            "connectorId": "connector_id_example",
            "notifyOn": "NOTIFY_ON_TRIGGERED_AND_RESOLVED",
            "presetId": "preset_id_example",
            "resolvedRouteOverrides": {},
            "triggeredRoutingOverrides": {}
          }
        ],
        "groupByKeys": [
          [
            "key1",
            "key2"
          ]
        ],
        "router": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
        },
        "webhooks": [
          {
            "integration": {},
            "minutes": 15,
            "notifyOn": "NOTIFY_ON_TRIGGERED_AND_RESOLVED"
          }
        ]
      },
      "notificationGroupExcess": [
        {
          "destinations": [
            {
              "connectorId": "connector_id_example",
              "notifyOn": "NOTIFY_ON_TRIGGERED_AND_RESOLVED",
              "presetId": "preset_id_example",
              "resolvedRouteOverrides": {},
              "triggeredRoutingOverrides": {}
            }
          ],
          "groupByKeys": [
            [
              "key1",
              "key2"
            ]
          ],
          "router": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
          },
          "webhooks": [
            {
              "integration": {},
              "minutes": 15,
              "notifyOn": "NOTIFY_ON_TRIGGERED_AND_RESOLVED"
            }
          ]
        }
      ],
      "phantomMode": false,
      "priority": "ALERT_DEF_PRIORITY_P4",
      "type": "ALERT_DEF_TYPE_METRIC_THRESHOLD"
    },
    "alertVersionId": "<string>",
    "createdTime": "2023-10-01T12:00:00.000Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "lastTriggeredTime": "2023-10-01T12:00:00.000Z",
    "status": "ALERT_DEF_STATUS_OK",
    "updatedTime": "2023-10-01T12:00:00.000Z"
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication

Body

application/json
  • Alert definition properties
  • Alert definition properties
  • Alert definition properties
  • Alert definition properties
  • Alert definition properties
  • Alert definition properties
  • Alert definition properties
  • Alert definition properties
  • Alert definition properties
  • Alert definition properties
  • Alert definition properties
  • Alert definition properties
  • Alert definition properties

User-configurable properties of an alert definition

​
name
string
required

The name of the alert definition

Example:

"My Alert"

​
priority
enum<string>
required

The priority level of the alert

Available options:
ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED,
ALERT_DEF_PRIORITY_P4,
ALERT_DEF_PRIORITY_P3,
ALERT_DEF_PRIORITY_P2,
ALERT_DEF_PRIORITY_P1
Example:

"ALERT_DEF_PRIORITY_P4"

​
type
enum<string>
required

Alert type

Available options:
ALERT_DEF_TYPE_LOGS_IMMEDIATE_OR_UNSPECIFIED,
ALERT_DEF_TYPE_LOGS_THRESHOLD,
ALERT_DEF_TYPE_LOGS_ANOMALY,
ALERT_DEF_TYPE_LOGS_RATIO_THRESHOLD,
ALERT_DEF_TYPE_LOGS_NEW_VALUE,
ALERT_DEF_TYPE_LOGS_UNIQUE_COUNT,
ALERT_DEF_TYPE_LOGS_TIME_RELATIVE_THRESHOLD,
ALERT_DEF_TYPE_METRIC_THRESHOLD,
ALERT_DEF_TYPE_METRIC_ANOMALY,
ALERT_DEF_TYPE_TRACING_IMMEDIATE,
ALERT_DEF_TYPE_TRACING_THRESHOLD,
ALERT_DEF_TYPE_FLOW,
ALERT_DEF_TYPE_SLO_THRESHOLD
Example:

"ALERT_DEF_TYPE_METRIC_THRESHOLD"

​
activeOn
object

Defines when an alert should be active based on days of the week and time windows

​
deleted
boolean

Whether the alert has been marked as deleted

Example:

false

​
description
string

A detailed description of what the alert monitors and when it triggers

Example:

"Alert description"

​
enabled
boolean

Whether the alert is currently active and monitoring

Example:

true

​
entityLabels
object[]
​
groupByKeys
string[]

Keys used to group and aggregate alert data

​
incidentsSettings
object
​
logsImmediate
object

Configuration for immediate alerts triggered on log entries matching specific filters.

​
notificationGroup
object
​
notificationGroupExcess
Alert definition notification group · object[]
​
phantomMode
boolean

Whether the alert is in phantom mode (creating incidents or not)

Example:

false

Response

A response that contains the newly created alert definition

​
alertDef
object
required

This data structure represents an alert definition