Skip to main content
Replace an alert definition
curl --request PUT \
  --url https://api.coralogix.com/mgmt/openapi/latest/alerts/alerts-general/v3 \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "alertDefProperties": {
    "activeOn": {
      "dayOfWeek": [
        "DAY_OF_WEEK_MONDAY_OR_UNSPECIFIED"
      ],
      "endTime": {
        "hours": 14,
        "minutes": 30
      },
      "startTime": {
        "hours": 14,
        "minutes": 30
      }
    },
    "deleted": false,
    "description": "Alert description",
    "enabled": true,
    "entityLabels": {
      "key": "value"
    },
    "groupByKeys": [
      [
        "key1",
        "key2"
      ]
    ],
    "incidentsSettings": {
      "minutes": 30,
      "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
    },
    "name": "My Alert",
    "notificationGroup": {
      "destinations": [
        {
          "connectorId": "connector_id_example",
          "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
          "presetId": "preset_id_example",
          "resolvedRouteOverrides": {
            "configOverrides": "<any>"
          },
          "triggeredRoutingOverrides": {
            "configOverrides": "<any>"
          }
        }
      ],
      "groupByKeys": [
        [
          "key1",
          "key2"
        ]
      ],
      "router": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
      },
      "webhooks": [
        {
          "integration": {
            "integrationId": "<any>"
          },
          "minutes": 15,
          "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
        }
      ]
    },
    "notificationGroupExcess": [
      {
        "destinations": [
          {
            "connectorId": "connector_id_example",
            "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
            "presetId": "preset_id_example",
            "resolvedRouteOverrides": {
              "configOverrides": "<any>"
            },
            "triggeredRoutingOverrides": {
              "configOverrides": "<any>"
            }
          }
        ],
        "groupByKeys": [
          [
            "key1",
            "key2"
          ]
        ],
        "router": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
        },
        "webhooks": [
          {
            "integration": {
              "integrationId": "<any>"
            },
            "minutes": 15,
            "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
          }
        ]
      }
    ],
    "phantomMode": false,
    "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED",
    "tracingImmediate": {
      "notificationPayloadFilter": [
        [
          "obj.field"
        ]
      ],
      "tracingFilter": {
        "simpleFilter": {
          "latencyThresholdMs": 1000,
          "tracingLabelFilters": {
            "applicationName": [
              "<any>"
            ],
            "operationName": [
              "<any>"
            ],
            "serviceName": [
              "<any>"
            ],
            "spanFields": [
              "<any>"
            ],
            "subsystemName": [
              "<any>"
            ]
          }
        }
      }
    },
    "type": "ALERT_DEF_TYPE_LOGS_IMMEDIATE_OR_UNSPECIFIED"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000"
}'
{
  "alertDef": {
    "alertDefProperties": {
      "activeOn": {
        "dayOfWeek": [
          "DAY_OF_WEEK_MONDAY_OR_UNSPECIFIED"
        ],
        "endTime": {
          "hours": 14,
          "minutes": 30
        },
        "startTime": {
          "hours": 14,
          "minutes": 30
        }
      },
      "deleted": false,
      "description": "Alert description",
      "enabled": true,
      "entityLabels": {
        "key": "value"
      },
      "groupByKeys": [
        [
          "key1",
          "key2"
        ]
      ],
      "incidentsSettings": {
        "minutes": 30,
        "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
      },
      "name": "My Alert",
      "notificationGroup": {
        "destinations": [
          {
            "connectorId": "connector_id_example",
            "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
            "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_ONLY_UNSPECIFIED"
          }
        ]
      },
      "notificationGroupExcess": [
        {
          "destinations": [
            {
              "connectorId": "connector_id_example",
              "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
              "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_ONLY_UNSPECIFIED"
            }
          ]
        }
      ],
      "phantomMode": false,
      "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED",
      "tracingImmediate": {
        "notificationPayloadFilter": [
          [
            "obj.field"
          ]
        ],
        "tracingFilter": {
          "simpleFilter": {
            "latencyThresholdMs": 1000,
            "tracingLabelFilters": {
              "applicationName": [
                "<any>"
              ],
              "operationName": [
                "<any>"
              ],
              "serviceName": [
                "<any>"
              ],
              "spanFields": [
                "<any>"
              ],
              "subsystemName": [
                "<any>"
              ]
            }
          }
        }
      },
      "type": "ALERT_DEF_TYPE_LOGS_IMMEDIATE_OR_UNSPECIFIED"
    },
    "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_UNSPECIFIED",
    "updatedTime": "2023-10-01T12:00:00.000Z"
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication

Body

application/json

A request to replace an existing alert definition

​
alertDefProperties
object
required

User-configurable properties of an alert definition

  • 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
​
id
string
required

Alert definition ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

A response that contains the updated alert definition

​
alertDef
object
required

This data structure represents an alert definition