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: '{"name":"My Alert","description":"Alert description","enabled":true,"priority":"ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED","activeOn":{"dayOfWeek":["DAY_OF_WEEK_MONDAY_OR_UNSPECIFIED","DAY_OF_WEEK_TUESDAY"],"startTime":{"hours":14,"minutes":30},"endTime":{"hours":14,"minutes":30}},"type":"ALERT_DEF_TYPE_LOGS_IMMEDIATE_OR_UNSPECIFIED","logsImmediate":{"logsFilter":{"simpleFilter":{"luceneQuery":"string","labelFilters":{"applicationName":[{"value":"my-app","operation":"LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"}],"subsystemName":[{"value":"my-app","operation":"LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"}],"severities":["LOG_SEVERITY_VERBOSE_UNSPECIFIED"]}}},"notificationPayloadFilter":["obj.field"]},"tracingImmediate":{"tracingFilter":{"simpleFilter":{"tracingLabelFilters":{"applicationName":[{"values":["value1","value2"],"operation":"TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"}],"subsystemName":[{"values":["value1","value2"],"operation":"TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"}],"serviceName":[{"values":["value1","value2"],"operation":"TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"}],"operationName":[{"values":["value1","value2"],"operation":"TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"}],"spanFields":[{"key":"span.field.key","filterType":{"values":["value1","value2"],"operation":"TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"}}]},"latencyThresholdMs":1000}},"notificationPayloadFilter":["obj.field"]},"logsThreshold":{"logsFilter":{"simpleFilter":{"luceneQuery":"string","labelFilters":{"applicationName":[{"value":"my-app","operation":"LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"}],"subsystemName":[{"value":"my-app","operation":"LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"}],"severities":["LOG_SEVERITY_VERBOSE_UNSPECIFIED"]}}},"undetectedValuesManagement":{"triggerUndetectedValues":true,"autoRetireTimeframe":"AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"},"rules":[{"condition":{"threshold":100,"timeWindow":{"logsTimeWindowSpecificValue":"LOGS_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"},"conditionType":"LOGS_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"},"override":{"priority":"ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"}}],"notificationPayloadFilter":["obj.field"],"evaluationDelayMs":60000},"logsRatioThreshold":{"numerator":{"simpleFilter":{"luceneQuery":"string","labelFilters":{"applicationName":[{"value":"my-app","operation":"LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"}],"subsystemName":[{"value":"my-app","operation":"LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"}],"severities":["LOG_SEVERITY_VERBOSE_UNSPECIFIED"]}}},"numeratorAlias":"numerator_alias","denominator":{"simpleFilter":{"luceneQuery":"string","labelFilters":{"applicationName":[{"value":"my-app","operation":"LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"}],"subsystemName":[{"value":"my-app","operation":"LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"}],"severities":["LOG_SEVERITY_VERBOSE_UNSPECIFIED"]}}},"denominatorAlias":"denominator_alias","rules":[{"condition":{"threshold":10,"timeWindow":{"logsRatioTimeWindowSpecificValue":"LOGS_RATIO_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"},"conditionType":"LOGS_RATIO_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"},"override":{"priority":"ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"}}],"notificationPayloadFilter":["obj.field"],"groupByFor":"LOGS_RATIO_GROUP_BY_FOR_BOTH_OR_UNSPECIFIED","undetectedValuesManagement":{"triggerUndetectedValues":true,"autoRetireTimeframe":"AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"},"ignoreInfinity":true,"evaluationDelayMs":60000},"logsTimeRelativeThreshold":{"logsFilter":{"simpleFilter":{"luceneQuery":"string","labelFilters":{"applicationName":[{"value":"my-app","operation":"LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"}],"subsystemName":[{"value":"my-app","operation":"LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"}],"severities":["LOG_SEVERITY_VERBOSE_UNSPECIFIED"]}}},"rules":[{"condition":{"threshold":0.1,"comparedTo":"LOGS_TIME_RELATIVE_COMPARED_TO_PREVIOUS_HOUR_OR_UNSPECIFIED","conditionType":"LOGS_TIME_RELATIVE_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"},"override":{"priority":"ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"}}],"ignoreInfinity":true,"notificationPayloadFilter":["obj.field"],"undetectedValuesManagement":{"triggerUndetectedValues":true,"autoRetireTimeframe":"AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"},"evaluationDelayMs":60000},"metricThreshold":{"metricFilter":{"promql":"avg_over_time(metric_name[5m]) > 10"},"rules":[{"condition":{"threshold":100,"forOverPct":80,"ofTheLast":{"metricTimeWindowSpecificValue":"METRIC_TIME_WINDOW_VALUE_MINUTES_1_OR_UNSPECIFIED","metricTimeWindowDynamicDuration":"1h30m"},"conditionType":"METRIC_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"},"override":{"priority":"ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"}}],"undetectedValuesManagement":{"triggerUndetectedValues":true,"autoRetireTimeframe":"AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"},"missingValues":{"replaceWithZero":true,"minNonNullValuesPct":80},"evaluationDelayMs":60000},"tracingThreshold":{"tracingFilter":{"simpleFilter":{"tracingLabelFilters":{"applicationName":[{"values":["value1","value2"],"operation":"TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"}],"subsystemName":[{"values":["value1","value2"],"operation":"TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"}],"serviceName":[{"values":["value1","value2"],"operation":"TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"}],"operationName":[{"values":["value1","value2"],"operation":"TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"}],"spanFields":[{"key":"span.field.key","filterType":{"values":["value1","value2"],"operation":"TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"}}]},"latencyThresholdMs":1000}},"rules":[{"condition":{"spanAmount":100,"timeWindow":{"tracingTimeWindowValue":"TRACING_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"},"conditionType":"TRACING_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"}}],"notificationPayloadFilter":["obj.field"]},"flow":{"stages":[{"flowStagesGroups":{"groups":[{"alertDefs":[{"id":"123e4567-e89b-12d3-a456-426614174000","not":true}],"nextOp":"NEXT_OP_AND_OR_UNSPECIFIED","alertsOp":"ALERTS_OP_AND_OR_UNSPECIFIED"}]},"timeframeMs":"string","timeframeType":"TIMEFRAME_TYPE_UNSPECIFIED"}],"enforceSuppression":true},"logsAnomaly":{"logsFilter":{"simpleFilter":{"luceneQuery":"string","labelFilters":{"applicationName":[{"value":"my-app","operation":"LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"}],"subsystemName":[{"value":"my-app","operation":"LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"}],"severities":["LOG_SEVERITY_VERBOSE_UNSPECIFIED"]}}},"rules":[{"condition":{"minimumThreshold":10,"timeWindow":{"logsTimeWindowSpecificValue":"LOGS_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"},"conditionType":"LOGS_ANOMALY_CONDITION_TYPE_MORE_THAN_USUAL_OR_UNSPECIFIED"}}],"notificationPayloadFilter":["obj.field"],"evaluationDelayMs":60000,"anomalyAlertSettings":{"percentageOfDeviation":0.1}},"metricAnomaly":{"metricFilter":{"promql":"avg_over_time(metric_name[5m]) > 10"},"rules":[{"condition":{"threshold":10,"forOverPct":20,"ofTheLast":{"metricTimeWindowSpecificValue":"METRIC_TIME_WINDOW_VALUE_MINUTES_1_OR_UNSPECIFIED","metricTimeWindowDynamicDuration":"1h30m"},"minNonNullValuesPct":10,"conditionType":"METRIC_ANOMALY_CONDITION_TYPE_MORE_THAN_USUAL_OR_UNSPECIFIED"}}],"evaluationDelayMs":60000,"anomalyAlertSettings":{"percentageOfDeviation":0.1}},"logsNewValue":{"logsFilter":{"simpleFilter":{"luceneQuery":"string","labelFilters":{"applicationName":[{"value":"my-app","operation":"LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"}],"subsystemName":[{"value":"my-app","operation":"LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"}],"severities":["LOG_SEVERITY_VERBOSE_UNSPECIFIED"]}}},"rules":[{"condition":{"keypathToTrack":"metadata.field","timeWindow":{"logsNewValueTimeWindowSpecificValue":"LOGS_NEW_VALUE_TIME_WINDOW_VALUE_HOURS_12_OR_UNSPECIFIED"}}}],"notificationPayloadFilter":["obj.field"]},"logsUniqueCount":{"logsFilter":{"simpleFilter":{"luceneQuery":"string","labelFilters":{"applicationName":[{"value":"my-app","operation":"LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"}],"subsystemName":[{"value":"my-app","operation":"LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED"}],"severities":["LOG_SEVERITY_VERBOSE_UNSPECIFIED"]}}},"rules":[{"condition":{"maxUniqueCount":100,"timeWindow":{"logsUniqueValueTimeWindowSpecificValue":"LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_MINUTE_1_OR_UNSPECIFIED"}}}],"notificationPayloadFilter":["obj.field"],"maxUniqueCountPerGroupByKey":100,"uniqueCountKeypath":"obj.field"},"sloThreshold":{"sloDefinition":{"sloId":"123e4567-e89b-12d3-a456-426614174000"},"errorBudget":{"rules":[{"condition":{"threshold":0.1},"override":{"priority":"ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"}}]},"burnRate":{"rules":[{"condition":{"threshold":0.1},"override":{"priority":"ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"}}],"dual":{"timeDuration":{"duration":60,"unit":"DURATION_UNIT_UNSPECIFIED"}},"single":{"timeDuration":{"duration":60,"unit":"DURATION_UNIT_UNSPECIFIED"}}}},"groupByKeys":["key1","key2"],"incidentsSettings":{"minutes":30,"notifyOn":"NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"},"notificationGroup":{"groupByKeys":["key1","key2"],"webhooks":[{"minutes":15,"notifyOn":"NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED","integration":{"integrationId":123,"recipients":{"emails":["mail@gmail.com"]}}}],"destinations":[{"connectorId":"connector_id_example","presetId":"preset_id_example","notifyOn":"NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED","triggeredRoutingOverrides":{"configOverrides":{"payloadType":"slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default","messageConfigFields":[{"fieldName":"description","template":"template_example"}],"connectorConfigFields":[{"fieldName":"description","template":"template_example"}]}},"resolvedRouteOverrides":{"configOverrides":{"payloadType":"slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default","messageConfigFields":[{"fieldName":"description","template":"template_example"}],"connectorConfigFields":[{"fieldName":"description","template":"template_example"}]}}}],"router":{"id":"123e4567-e89b-12d3-a456-426614174000","notifyOn":"NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"}},"notificationGroupExcess":[{"groupByKeys":["key1","key2"],"webhooks":[{"minutes":15,"notifyOn":"NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED","integration":{"integrationId":123,"recipients":{"emails":["mail@gmail.com"]}}}],"destinations":[{"connectorId":"connector_id_example","presetId":"preset_id_example","notifyOn":"NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED","triggeredRoutingOverrides":{"configOverrides":{"payloadType":"slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default","messageConfigFields":[{"fieldName":"description","template":"template_example"}],"connectorConfigFields":[{"fieldName":"description","template":"template_example"}]}},"resolvedRouteOverrides":{"configOverrides":{"payloadType":"slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default","messageConfigFields":[{"fieldName":"description","template":"template_example"}],"connectorConfigFields":[{"fieldName":"description","template":"template_example"}]}}}],"router":{"id":"123e4567-e89b-12d3-a456-426614174000","notifyOn":"NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"}}],"entityLabels":{"key":"value"},"phantomMode":false,"deleted":false}'
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
{
  "alertDef": {
    "alertDefProperties": {
      "name": "My Alert",
      "description": "Alert description",
      "enabled": true,
      "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED",
      "activeOn": {
        "dayOfWeek": [
          "DAY_OF_WEEK_MONDAY_OR_UNSPECIFIED",
          "DAY_OF_WEEK_TUESDAY"
        ],
        "startTime": {
          "hours": 14,
          "minutes": 30
        },
        "endTime": {
          "hours": 14,
          "minutes": 30
        }
      },
      "type": "ALERT_DEF_TYPE_LOGS_IMMEDIATE_OR_UNSPECIFIED",
      "logsImmediate": {
        "logsFilter": {
          "simpleFilter": {
            "luceneQuery": "<string>",
            "labelFilters": {
              "applicationName": [
                "<any>"
              ],
              "subsystemName": [
                "<any>"
              ],
              "severities": [
                "<any>"
              ]
            }
          }
        },
        "notificationPayloadFilter": [
          "obj.field"
        ]
      },
      "tracingImmediate": {
        "tracingFilter": {
          "simpleFilter": {
            "tracingLabelFilters": {
              "applicationName": [
                "<any>"
              ],
              "subsystemName": [
                "<any>"
              ],
              "serviceName": [
                "<any>"
              ],
              "operationName": [
                "<any>"
              ],
              "spanFields": [
                "<any>"
              ]
            },
            "latencyThresholdMs": 1000
          }
        },
        "notificationPayloadFilter": [
          "obj.field"
        ]
      },
      "logsThreshold": {
        "logsFilter": {
          "simpleFilter": {
            "luceneQuery": "<string>",
            "labelFilters": {
              "applicationName": [
                "<any>"
              ],
              "subsystemName": [
                "<any>"
              ],
              "severities": [
                "<any>"
              ]
            }
          }
        },
        "undetectedValuesManagement": {
          "triggerUndetectedValues": true,
          "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
        },
        "rules": [
          {
            "condition": {
              "threshold": 100,
              "timeWindow": {
                "logsTimeWindowSpecificValue": "LOGS_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
              },
              "conditionType": "LOGS_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
            },
            "override": {
              "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
            }
          }
        ],
        "notificationPayloadFilter": [
          "obj.field"
        ],
        "evaluationDelayMs": 60000
      },
      "logsRatioThreshold": {
        "numerator": {
          "simpleFilter": {
            "luceneQuery": "<string>",
            "labelFilters": {
              "applicationName": [
                "<any>"
              ],
              "subsystemName": [
                "<any>"
              ],
              "severities": [
                "<any>"
              ]
            }
          }
        },
        "numeratorAlias": "numerator_alias",
        "denominator": {
          "simpleFilter": {
            "luceneQuery": "<string>",
            "labelFilters": {
              "applicationName": [
                "<any>"
              ],
              "subsystemName": [
                "<any>"
              ],
              "severities": [
                "<any>"
              ]
            }
          }
        },
        "denominatorAlias": "denominator_alias",
        "rules": [
          {
            "condition": {
              "threshold": 10,
              "timeWindow": {
                "logsRatioTimeWindowSpecificValue": "LOGS_RATIO_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
              },
              "conditionType": "LOGS_RATIO_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
            },
            "override": {
              "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
            }
          }
        ],
        "notificationPayloadFilter": [
          "obj.field"
        ],
        "groupByFor": "LOGS_RATIO_GROUP_BY_FOR_BOTH_OR_UNSPECIFIED",
        "undetectedValuesManagement": {
          "triggerUndetectedValues": true,
          "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
        },
        "ignoreInfinity": true,
        "evaluationDelayMs": 60000
      },
      "logsTimeRelativeThreshold": {
        "logsFilter": {
          "simpleFilter": {
            "luceneQuery": "<string>",
            "labelFilters": {
              "applicationName": [
                "<any>"
              ],
              "subsystemName": [
                "<any>"
              ],
              "severities": [
                "<any>"
              ]
            }
          }
        },
        "rules": [
          {
            "condition": {
              "threshold": 123,
              "comparedTo": "LOGS_TIME_RELATIVE_COMPARED_TO_PREVIOUS_HOUR_OR_UNSPECIFIED",
              "conditionType": "LOGS_TIME_RELATIVE_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
            },
            "override": {
              "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
            }
          }
        ],
        "ignoreInfinity": true,
        "notificationPayloadFilter": [
          "obj.field"
        ],
        "undetectedValuesManagement": {
          "triggerUndetectedValues": true,
          "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
        },
        "evaluationDelayMs": 60000
      },
      "metricThreshold": {
        "metricFilter": {
          "promql": "avg_over_time(metric_name[5m]) > 10"
        },
        "rules": [
          {
            "condition": {
              "threshold": 100,
              "forOverPct": 80,
              "ofTheLast": {
                "metricTimeWindowSpecificValue": "METRIC_TIME_WINDOW_VALUE_MINUTES_1_OR_UNSPECIFIED",
                "metricTimeWindowDynamicDuration": "1h30m"
              },
              "conditionType": "METRIC_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
            },
            "override": {
              "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
            }
          }
        ],
        "undetectedValuesManagement": {
          "triggerUndetectedValues": true,
          "autoRetireTimeframe": "AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED"
        },
        "missingValues": {
          "replaceWithZero": true,
          "minNonNullValuesPct": 80
        },
        "evaluationDelayMs": 60000
      },
      "tracingThreshold": {
        "tracingFilter": {
          "simpleFilter": {
            "tracingLabelFilters": {
              "applicationName": [
                "<any>"
              ],
              "subsystemName": [
                "<any>"
              ],
              "serviceName": [
                "<any>"
              ],
              "operationName": [
                "<any>"
              ],
              "spanFields": [
                "<any>"
              ]
            },
            "latencyThresholdMs": 1000
          }
        },
        "rules": [
          {
            "condition": {
              "spanAmount": 100,
              "timeWindow": {
                "tracingTimeWindowValue": "TRACING_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
              },
              "conditionType": "TRACING_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED"
            }
          }
        ],
        "notificationPayloadFilter": [
          "obj.field"
        ]
      },
      "flow": {
        "stages": [
          {
            "flowStagesGroups": {
              "groups": [
                {
                  "alertDefs": [
                    {
                      "id": "<any>",
                      "not": "<any>"
                    }
                  ],
                  "nextOp": "NEXT_OP_AND_OR_UNSPECIFIED",
                  "alertsOp": "ALERTS_OP_AND_OR_UNSPECIFIED"
                }
              ]
            },
            "timeframeMs": "<string>",
            "timeframeType": "TIMEFRAME_TYPE_UNSPECIFIED"
          }
        ],
        "enforceSuppression": true
      },
      "logsAnomaly": {
        "logsFilter": {
          "simpleFilter": {
            "luceneQuery": "<string>",
            "labelFilters": {
              "applicationName": [
                "<any>"
              ],
              "subsystemName": [
                "<any>"
              ],
              "severities": [
                "<any>"
              ]
            }
          }
        },
        "rules": [
          {
            "condition": {
              "minimumThreshold": 10,
              "timeWindow": {
                "logsTimeWindowSpecificValue": "LOGS_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED"
              },
              "conditionType": "LOGS_ANOMALY_CONDITION_TYPE_MORE_THAN_USUAL_OR_UNSPECIFIED"
            }
          }
        ],
        "notificationPayloadFilter": [
          "obj.field"
        ],
        "evaluationDelayMs": 60000,
        "anomalyAlertSettings": {
          "percentageOfDeviation": 123
        }
      },
      "metricAnomaly": {
        "metricFilter": {
          "promql": "avg_over_time(metric_name[5m]) > 10"
        },
        "rules": [
          {
            "condition": {
              "threshold": 10,
              "forOverPct": 20,
              "ofTheLast": {
                "metricTimeWindowSpecificValue": "METRIC_TIME_WINDOW_VALUE_MINUTES_1_OR_UNSPECIFIED",
                "metricTimeWindowDynamicDuration": "1h30m"
              },
              "minNonNullValuesPct": 10,
              "conditionType": "METRIC_ANOMALY_CONDITION_TYPE_MORE_THAN_USUAL_OR_UNSPECIFIED"
            }
          }
        ],
        "evaluationDelayMs": 60000,
        "anomalyAlertSettings": {
          "percentageOfDeviation": 123
        }
      },
      "logsNewValue": {
        "logsFilter": {
          "simpleFilter": {
            "luceneQuery": "<string>",
            "labelFilters": {
              "applicationName": [
                "<any>"
              ],
              "subsystemName": [
                "<any>"
              ],
              "severities": [
                "<any>"
              ]
            }
          }
        },
        "rules": [
          {
            "condition": {
              "keypathToTrack": "metadata.field",
              "timeWindow": {
                "logsNewValueTimeWindowSpecificValue": "LOGS_NEW_VALUE_TIME_WINDOW_VALUE_HOURS_12_OR_UNSPECIFIED"
              }
            }
          }
        ],
        "notificationPayloadFilter": [
          "obj.field"
        ]
      },
      "logsUniqueCount": {
        "logsFilter": {
          "simpleFilter": {
            "luceneQuery": "<string>",
            "labelFilters": {
              "applicationName": [
                "<any>"
              ],
              "subsystemName": [
                "<any>"
              ],
              "severities": [
                "<any>"
              ]
            }
          }
        },
        "rules": [
          {
            "condition": {
              "maxUniqueCount": 100,
              "timeWindow": {
                "logsUniqueValueTimeWindowSpecificValue": "LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_MINUTE_1_OR_UNSPECIFIED"
              }
            }
          }
        ],
        "notificationPayloadFilter": [
          "obj.field"
        ],
        "maxUniqueCountPerGroupByKey": 100,
        "uniqueCountKeypath": "obj.field"
      },
      "sloThreshold": {
        "sloDefinition": {
          "sloId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "errorBudget": {
          "rules": [
            {
              "condition": {
                "threshold": 123
              },
              "override": {
                "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
              }
            }
          ]
        },
        "burnRate": {
          "rules": [
            {
              "condition": {
                "threshold": 123
              },
              "override": {
                "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED"
              }
            }
          ],
          "dual": {
            "timeDuration": {
              "duration": 60,
              "unit": "DURATION_UNIT_UNSPECIFIED"
            }
          },
          "single": {
            "timeDuration": {
              "duration": 60,
              "unit": "DURATION_UNIT_UNSPECIFIED"
            }
          }
        }
      },
      "groupByKeys": [
        "key1",
        "key2"
      ],
      "incidentsSettings": {
        "minutes": 30,
        "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
      },
      "notificationGroup": {
        "groupByKeys": [
          "key1",
          "key2"
        ],
        "webhooks": [
          {
            "minutes": 15,
            "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
            "integration": {
              "integrationId": "<any>",
              "recipients": "<any>"
            }
          }
        ],
        "destinations": [
          {
            "connectorId": "connector_id_example",
            "presetId": "preset_id_example",
            "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
            "triggeredRoutingOverrides": {
              "configOverrides": "<any>"
            },
            "resolvedRouteOverrides": {
              "configOverrides": "<any>"
            }
          }
        ],
        "router": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
        }
      },
      "notificationGroupExcess": [
        {
          "groupByKeys": [
            "key1",
            "key2"
          ],
          "webhooks": [
            {
              "minutes": 15,
              "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
              "integration": {
                "integrationId": "<any>",
                "recipients": "<any>"
              }
            }
          ],
          "destinations": [
            {
              "connectorId": "connector_id_example",
              "presetId": "preset_id_example",
              "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
              "triggeredRoutingOverrides": {
                "configOverrides": "<any>"
              },
              "resolvedRouteOverrides": {
                "configOverrides": "<any>"
              }
            }
          ],
          "router": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
          }
        }
      ],
      "entityLabels": {
        "key": "value"
      },
      "phantomMode": false,
      "deleted": false
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "alertVersionId": "<string>",
    "createdTime": "2023-10-01T12:00:00.000Z",
    "updatedTime": "2023-10-01T12:00:00.000Z",
    "lastTriggeredTime": "2023-10-01T12:00:00.000Z"
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication

Body

application/json

User-configurable properties of an alert definition

​
name
string
required

The name of the alert definition

Example:

"My Alert"

​
priority
enum<string>
default:ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED
required
Available options:
ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED,
ALERT_DEF_PRIORITY_P4,
ALERT_DEF_PRIORITY_P3,
ALERT_DEF_PRIORITY_P2,
ALERT_DEF_PRIORITY_P1
​
type
enum<string>
default:ALERT_DEF_TYPE_LOGS_IMMEDIATE_OR_UNSPECIFIED
required
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
​
description
string

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

Example:

"Alert description"

​
enabled
boolean
default:true

Whether the alert is currently active and monitoring

Example:

true

​
activeOn
object

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

​
logsImmediate
object

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

​
tracingImmediate
object

Configuration for immediate alerts triggered on trace entries

​
logsThreshold
object

Configuration for alerts triggered when log counts exceed or fall below specified thresholds

​
logsRatioThreshold
object

Configuration for alerts based on the ratio between two log queries

​
logsTimeRelativeThreshold
object

Configuration for alerts that are triggered when a fixed ratio reaches a set threshold compared to a past time frame.

​
metricThreshold
object

Configuration for alerts based on metric threshold violations

​
tracingThreshold
object

Configuration for alerts based on trace count thresholds

​
flow
object

Configuration for flow-based alerts with multiple stages

​
logsAnomaly
object

Configuration for alerts triggered by anomalous log patterns

​
metricAnomaly
object

Configuration for alerts triggered by anomalous metric patterns

​
logsNewValue
object

Configuration for alerts triggered by new values appearing in logs

​
logsUniqueCount
object

Configuration for alerts based on unique value counts in logs

​
sloThreshold
object

SLO threshold type definition

​
groupByKeys
string[]

Keys used to group and aggregate alert data

Example:
["key1", "key2"]
​
incidentsSettings
object
​
notificationGroup
object
​
notificationGroupExcess
Alert definition notification group · object[]

Additional notification groups for alerts (deprecated)

​
entityLabels
object

Labels used to identify and categorize the alert entity

Example:
{ "key": "value" }
​
phantomMode
boolean
default:false

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

Example:

false

​
deleted
boolean
default:false

Whether the alert has been marked as deleted

Example:

false

Response

A successful response.

A response that contains the newly created alert definition

​
alertDef
object
required

This data structure represents an alert definition

⌘I