Skip to main content
Theme
Home

Replace an alert definition

PUThttps://api.coralogix.com/mgmt/openapi/5/alerts/alerts/v3

Updates an existing alert definition.

Requires the following permissions:

  • alerts:UpdateConfig

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 replace an existing alert definition

    alertDefProperties#object

    User-configurable properties of an alert definition

    oneOf
    object

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

    Configuration for analytics alerts that fire immediately when a DataPrime query returns a result

    Configuration for alerts that fire when a numeric column in a DataPrime query result violates a threshold

    The sources from which to sample logs

    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

    Labels used to identify and categorize the alert entity

    Configuration for flow-based alerts with multiple stages

    alertDefProperties.groupByKeys#string[]

    Keys used to group and aggregate alert data

    Example: ["key1","key2"]

    Alert def incident settings.

    Configuration for alerts triggered by anomalous log patterns

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

    Configuration for alerts triggered by new values appearing in logs

    Configuration for alerts based on the ratio between two log queries

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

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

    Configuration for alerts based on unique value counts in logs

    Configuration for alerts triggered by anomalous metric patterns

    Configuration for alerts based on metric threshold violations

    alertDefProperties.name#string

    The name of the alert definition

    Example: My Alert

    Alert def notification group.

    Additional notification groups for alerts (deprecated)

    alertDefProperties.phantomMode#boolean

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

    Example: false
    alertDefProperties.priority#AlertDefPriority

    Alert def priority.

    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.sloThreshold#object

    SLO threshold type definition

    oneOf
    object
    alertDefProperties.sloThreshold.burnRate#object

    Burn rate threshold definition

    oneOf
    object

    Burn rate type dual definition

    The rules for the burn rate threshold

    Possible values: >= 1, <= 5

    Burn rate type single definition

    Error budget threshold definition

    Configuration for SLO definition

    Configuration for immediate alerts triggered on trace entries

    Configuration for alerts based on trace count thresholds

    alertDefProperties.type#AlertDefType

    Alert def type.

    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, ALERT_DEF_TYPE_ANALYTICS_IMMEDIATE, ALERT_DEF_TYPE_ANALYTICS_THRESHOLD]

    id#string

    Alert definition ID

    Example: 123e4567-e89b-12d3-a456-426614174000

Response

application/json

A response that contains the updated alert definition