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

let url = 'https://api.coralogix.com/mgmt/openapi/v3/alert-defs?queryFilter.nameFilter.name=SOME_ARRAY_VALUE&queryFilter.nameFilter.matcher=SOME_STRING_VALUE&queryFilter.typeFilter.type=SOME_ARRAY_VALUE&queryFilter.typeFilter.matcher=SOME_STRING_VALUE&queryFilter.entityLabelsFilter.entityLabels=SOME_STRING_VALUE&queryFilter.entityLabelsFilter.valuesOperator=SOME_STRING_VALUE&queryFilter.priorityFilter.priority=SOME_ARRAY_VALUE&queryFilter.priorityFilter.matcher=SOME_STRING_VALUE&queryFilter.enabledFilter.enabled=SOME_BOOLEAN_VALUE&queryFilter.modifiedTimeRangeFilter.modifiedAtRange.startTime=SOME_STRING_VALUE&queryFilter.modifiedTimeRangeFilter.modifiedAtRange.endTime=SOME_STRING_VALUE&queryFilter.lastTriggeredTimeRangeFilter.lastTriggeredAtRange.startTime=SOME_STRING_VALUE&queryFilter.lastTriggeredTimeRangeFilter.lastTriggeredAtRange.endTime=SOME_STRING_VALUE&queryFilter.typeSpecificFilter.sloFilter.sloId=SOME_ARRAY_VALUE&queryFilter.typeSpecificFilter.sloFilter.matcher=SOME_STRING_VALUE&pagination.pageSize=SOME_INTEGER_VALUE&pagination.pageToken=SOME_STRING_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
{
  "alertDefs": [
    {
      "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": [
                      "<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": {}
            }
          ],
          "destinations": [
            {
              "connectorId": "connector_id_example",
              "presetId": "preset_id_example",
              "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
              "triggeredRoutingOverrides": {},
              "resolvedRouteOverrides": {}
            }
          ],
          "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": {}
              }
            ],
            "destinations": [
              {
                "connectorId": "connector_id_example",
                "presetId": "preset_id_example",
                "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
                "triggeredRoutingOverrides": {},
                "resolvedRouteOverrides": {}
              }
            ],
            "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"
    }
  ],
  "pagination": {
    "totalSize": 123,
    "nextPageToken": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication

Query Parameters

​
queryFilter.nameFilter.name
string[]
required

The name(s) of the alert definition - multiple values are OR'd together

​
queryFilter.nameFilter.matcher
enum<string>
default:FILTER_MATCHER_UNSPECIFIED
required

The filter operator (EQUALS, NOT_EQUALS, CONTAINS)

Available options:
FILTER_MATCHER_UNSPECIFIED,
FILTER_MATCHER_EQUALS,
FILTER_MATCHER_NOT_EQUALS,
FILTER_MATCHER_CONTAINS
​
queryFilter.typeFilter.type
enum<string>[]
required

The alert type(s) - multiple values are OR'd together

​
queryFilter.typeFilter.matcher
enum<string>
default:FILTER_MATCHER_UNSPECIFIED
required

The filter operator (EQUALS, NOT_EQUALS)

Available options:
FILTER_MATCHER_UNSPECIFIED,
FILTER_MATCHER_EQUALS,
FILTER_MATCHER_NOT_EQUALS,
FILTER_MATCHER_CONTAINS
​
queryFilter.entityLabelsFilter.entityLabels
string

The entity label key-value pairs to filter by

​
queryFilter.entityLabelsFilter.valuesOperator
enum<string>
default:FILTER_VALUES_OPERATOR_UNSPECIFIED
required

Whether all labels must match (AND) or any label can match (OR)

Available options:
FILTER_VALUES_OPERATOR_UNSPECIFIED,
FILTER_VALUES_OPERATOR_OR,
FILTER_VALUES_OPERATOR_AND
​
queryFilter.priorityFilter.priority
enum<string>[]
required

The priority(ies) of the alert definition - multiple values are OR'd together

​
queryFilter.priorityFilter.matcher
enum<string>
default:FILTER_MATCHER_UNSPECIFIED
required

The filter operator (EQUALS, NOT_EQUALS)

Available options:
FILTER_MATCHER_UNSPECIFIED,
FILTER_MATCHER_EQUALS,
FILTER_MATCHER_NOT_EQUALS,
FILTER_MATCHER_CONTAINS
​
queryFilter.enabledFilter.enabled
boolean
required

Whether to filter for enabled (true) or disabled (false) alerts

​
queryFilter.modifiedTimeRangeFilter.modifiedAtRange.startTime
string<date-time>
required

Start time of the range

​
queryFilter.modifiedTimeRangeFilter.modifiedAtRange.endTime
string<date-time>
required

End time of the range

​
queryFilter.lastTriggeredTimeRangeFilter.lastTriggeredAtRange.startTime
string<date-time>
required

Start time of the range

​
queryFilter.lastTriggeredTimeRangeFilter.lastTriggeredAtRange.endTime
string<date-time>
required

End time of the range

​
queryFilter.typeSpecificFilter.sloFilter.sloId
string[]
required

The SLO ID(s) to filter by - multiple values are OR'd together

​
queryFilter.typeSpecificFilter.sloFilter.matcher
enum<string>
default:FILTER_MATCHER_UNSPECIFIED
required

The filter operator (EQUALS, NOT_EQUALS)

Available options:
FILTER_MATCHER_UNSPECIFIED,
FILTER_MATCHER_EQUALS,
FILTER_MATCHER_NOT_EQUALS,
FILTER_MATCHER_CONTAINS
​
pagination.pageSize
integer
​
pagination.pageToken
string

Response

A successful response.

A response that contains a list of alert definitions

​
alertDefs
Alert definition · object[]
required

List of alert definitions

​
pagination
object
⌘I