You are viewing v3 of the Coralogix API. v5 is the current version. Go to the v5 reference

Create an alert

POSThttps://api.coralogix.com/mgmt/openapi/3/alerts/alerts-general/v3

No description available

Authorizations

Authorizationstringheaderrequired

API key authentication

The value is a Coralogix API key. Create a personal or team API key and assign its permissions.

Request

Body

application/json

A request to create a new alert definition

alertDefProperties#object

User-configurable properties of an alert definition

oneOf

• Option 1
• Option 2
• Option 3
• Option 4
• Option 5
• Option 6
• Option 7
• Option 8
• Option 9
• Option 10
• Option 11
• Option 12
• Option 13

alertDefProperties.activeOn# object

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

alertDefProperties.deleted#boolean

Whether the alert has been marked as deleted

Example: false

alertDefProperties.description#string

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

Example: Alert description

alertDefProperties.enabled#boolean

Whether the alert is currently active and monitoring

Example: true

alertDefProperties.entityLabels# object

Labels used to identify and categorize the alert entity

alertDefProperties.groupByKeys#string[]

Example: ["key1","key2"]

alertDefProperties.incidentsSettings# object

alertDefProperties.logsImmediate# object

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

alertDefProperties.name#string

The name of the alert definition

Example: My Alert

alertDefProperties.notificationGroup# object

alertDefProperties.notificationGroupExcess# object[]

alertDefProperties.phantomMode#boolean

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

Example: false

alertDefProperties.priority#AlertDefPriority

Possible values: [ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED, ALERT_DEF_PRIORITY_P4, ALERT_DEF_PRIORITY_P3, ALERT_DEF_PRIORITY_P2, ALERT_DEF_PRIORITY_P1]

alertDefProperties.type#AlertDefType

Possible values: [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]

Response

200400401500application/json

A response that contains the newly created alert definition

alertDef# object