Bulk replace alert definitions

curl --request PUT \
  --url https://api.coralogix.com/mgmt/openapi/latest/alerts/alerts-general/v3/bulk \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "alertDefsToReplace": [
    {
      "alertDefProperties": {
        "name": "My Alert",
        "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED",
        "type": "ALERT_DEF_TYPE_LOGS_IMMEDIATE_OR_UNSPECIFIED",
        "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"
        },
        "notificationGroup": {
          "destinations": [
            {
              "connectorId": "connector_id_example",
              "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
              "presetId": "preset_id_example",
              "resolvedRouteOverrides": {
                "configOverrides": {
                  "connectorConfigFields": [
                    {
                      "fieldName": "description",
                      "template": "template_example"
                    }
                  ],
                  "messageConfigFields": [
                    {
                      "fieldName": "description",
                      "template": "template_example"
                    }
                  ],
                  "payloadType": "slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"
                }
              },
              "triggeredRoutingOverrides": {
                "configOverrides": {
                  "connectorConfigFields": [
                    {
                      "fieldName": "description",
                      "template": "template_example"
                    }
                  ],
                  "messageConfigFields": [
                    {
                      "fieldName": "description",
                      "template": "template_example"
                    }
                  ],
                  "payloadType": "slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"
                }
              }
            }
          ],
          "groupByKeys": [
            [
              "key1",
              "key2"
            ]
          ],
          "router": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
          },
          "webhooks": [
            {
              "integration": {
                "integrationId": 123
              },
              "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": {
                    "connectorConfigFields": [
                      {
                        "fieldName": "description",
                        "template": "template_example"
                      }
                    ],
                    "messageConfigFields": [
                      {
                        "fieldName": "description",
                        "template": "template_example"
                      }
                    ],
                    "payloadType": "slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"
                  }
                },
                "triggeredRoutingOverrides": {
                  "configOverrides": {
                    "connectorConfigFields": [
                      {
                        "fieldName": "description",
                        "template": "template_example"
                      }
                    ],
                    "messageConfigFields": [
                      {
                        "fieldName": "description",
                        "template": "template_example"
                      }
                    ],
                    "payloadType": "slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"
                  }
                }
              }
            ],
            "groupByKeys": [
              [
                "key1",
                "key2"
              ]
            ],
            "router": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
            },
            "webhooks": [
              {
                "integration": {
                  "integrationId": 123
                },
                "minutes": 15,
                "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
              }
            ]
          }
        ],
        "phantomMode": false,
        "tracingImmediate": {
          "tracingFilter": {
            "simpleFilter": {
              "latencyThresholdMs": 1000,
              "tracingLabelFilters": {
                "applicationName": [
                  {
                    "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED",
                    "values": [
                      [
                        "value1",
                        "value2"
                      ]
                    ]
                  }
                ],
                "operationName": [
                  {
                    "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED",
                    "values": [
                      [
                        "value1",
                        "value2"
                      ]
                    ]
                  }
                ],
                "serviceName": [
                  {
                    "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED",
                    "values": [
                      [
                        "value1",
                        "value2"
                      ]
                    ]
                  }
                ],
                "spanFields": [
                  {
                    "filterType": {
                      "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED",
                      "values": [
                        [
                          "value1",
                          "value2"
                        ]
                      ]
                    },
                    "key": "span.field.key"
                  }
                ],
                "subsystemName": [
                  {
                    "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED",
                    "values": [
                      [
                        "value1",
                        "value2"
                      ]
                    ]
                  }
                ]
              }
            }
          },
          "notificationPayloadFilter": [
            [
              "obj.field"
            ]
          ]
        }
      },
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}
'

{
  "alertDefs": [
    {
      "alertDefProperties": {
        "name": "My Alert",
        "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED",
        "type": "ALERT_DEF_TYPE_LOGS_IMMEDIATE_OR_UNSPECIFIED",
        "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"
        },
        "notificationGroup": {
          "destinations": [
            {
              "connectorId": "connector_id_example",
              "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
              "presetId": "preset_id_example",
              "resolvedRouteOverrides": {
                "configOverrides": {
                  "connectorConfigFields": [
                    {
                      "fieldName": "description",
                      "template": "template_example"
                    }
                  ],
                  "messageConfigFields": [
                    {
                      "fieldName": "description",
                      "template": "template_example"
                    }
                  ],
                  "payloadType": "slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"
                }
              },
              "triggeredRoutingOverrides": {
                "configOverrides": {
                  "connectorConfigFields": [
                    {
                      "fieldName": "description",
                      "template": "template_example"
                    }
                  ],
                  "messageConfigFields": [
                    {
                      "fieldName": "description",
                      "template": "template_example"
                    }
                  ],
                  "payloadType": "slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"
                }
              }
            }
          ],
          "groupByKeys": [
            [
              "key1",
              "key2"
            ]
          ],
          "router": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
          },
          "webhooks": [
            {
              "integration": {
                "integrationId": 123
              },
              "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": {
                    "connectorConfigFields": [
                      {
                        "fieldName": "description",
                        "template": "template_example"
                      }
                    ],
                    "messageConfigFields": [
                      {
                        "fieldName": "description",
                        "template": "template_example"
                      }
                    ],
                    "payloadType": "slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"
                  }
                },
                "triggeredRoutingOverrides": {
                  "configOverrides": {
                    "connectorConfigFields": [
                      {
                        "fieldName": "description",
                        "template": "template_example"
                      }
                    ],
                    "messageConfigFields": [
                      {
                        "fieldName": "description",
                        "template": "template_example"
                      }
                    ],
                    "payloadType": "slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"
                  }
                }
              }
            ],
            "groupByKeys": [
              [
                "key1",
                "key2"
              ]
            ],
            "router": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
            },
            "webhooks": [
              {
                "integration": {
                  "integrationId": 123
                },
                "minutes": 15,
                "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
              }
            ]
          }
        ],
        "phantomMode": false,
        "tracingImmediate": {
          "tracingFilter": {
            "simpleFilter": {
              "latencyThresholdMs": 1000,
              "tracingLabelFilters": {
                "applicationName": [
                  {
                    "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED",
                    "values": [
                      [
                        "value1",
                        "value2"
                      ]
                    ]
                  }
                ],
                "operationName": [
                  {
                    "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED",
                    "values": [
                      [
                        "value1",
                        "value2"
                      ]
                    ]
                  }
                ],
                "serviceName": [
                  {
                    "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED",
                    "values": [
                      [
                        "value1",
                        "value2"
                      ]
                    ]
                  }
                ],
                "spanFields": [
                  {
                    "filterType": {
                      "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED",
                      "values": [
                        [
                          "value1",
                          "value2"
                        ]
                      ]
                    },
                    "key": "span.field.key"
                  }
                ],
                "subsystemName": [
                  {
                    "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED",
                    "values": [
                      [
                        "value1",
                        "value2"
                      ]
                    ]
                  }
                ]
              }
            }
          },
          "notificationPayloadFilter": [
            [
              "obj.field"
            ]
          ]
        }
      },
      "alertVersionId": "<string>",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdTime": "2023-10-01T12:00:00.000Z",
      "lastTriggeredTime": "2023-10-01T12:00:00.000Z",
      "status": "ALERT_DEF_STATUS_UNSPECIFIED",
      "updatedTime": "2023-10-01T12:00:00.000Z"
    }
  ],
  "failedToReplaceAlertDefs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "notFoundIds": [
    [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  ],
  "skippedIds": [
    [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  ]
}

PUT

alerts

alerts-general

bulk

Bulk replace alert definitions

curl --request PUT \
  --url https://api.coralogix.com/mgmt/openapi/latest/alerts/alerts-general/v3/bulk \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "alertDefsToReplace": [
    {
      "alertDefProperties": {
        "name": "My Alert",
        "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED",
        "type": "ALERT_DEF_TYPE_LOGS_IMMEDIATE_OR_UNSPECIFIED",
        "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"
        },
        "notificationGroup": {
          "destinations": [
            {
              "connectorId": "connector_id_example",
              "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
              "presetId": "preset_id_example",
              "resolvedRouteOverrides": {
                "configOverrides": {
                  "connectorConfigFields": [
                    {
                      "fieldName": "description",
                      "template": "template_example"
                    }
                  ],
                  "messageConfigFields": [
                    {
                      "fieldName": "description",
                      "template": "template_example"
                    }
                  ],
                  "payloadType": "slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"
                }
              },
              "triggeredRoutingOverrides": {
                "configOverrides": {
                  "connectorConfigFields": [
                    {
                      "fieldName": "description",
                      "template": "template_example"
                    }
                  ],
                  "messageConfigFields": [
                    {
                      "fieldName": "description",
                      "template": "template_example"
                    }
                  ],
                  "payloadType": "slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"
                }
              }
            }
          ],
          "groupByKeys": [
            [
              "key1",
              "key2"
            ]
          ],
          "router": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
          },
          "webhooks": [
            {
              "integration": {
                "integrationId": 123
              },
              "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": {
                    "connectorConfigFields": [
                      {
                        "fieldName": "description",
                        "template": "template_example"
                      }
                    ],
                    "messageConfigFields": [
                      {
                        "fieldName": "description",
                        "template": "template_example"
                      }
                    ],
                    "payloadType": "slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"
                  }
                },
                "triggeredRoutingOverrides": {
                  "configOverrides": {
                    "connectorConfigFields": [
                      {
                        "fieldName": "description",
                        "template": "template_example"
                      }
                    ],
                    "messageConfigFields": [
                      {
                        "fieldName": "description",
                        "template": "template_example"
                      }
                    ],
                    "payloadType": "slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"
                  }
                }
              }
            ],
            "groupByKeys": [
              [
                "key1",
                "key2"
              ]
            ],
            "router": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
            },
            "webhooks": [
              {
                "integration": {
                  "integrationId": 123
                },
                "minutes": 15,
                "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
              }
            ]
          }
        ],
        "phantomMode": false,
        "tracingImmediate": {
          "tracingFilter": {
            "simpleFilter": {
              "latencyThresholdMs": 1000,
              "tracingLabelFilters": {
                "applicationName": [
                  {
                    "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED",
                    "values": [
                      [
                        "value1",
                        "value2"
                      ]
                    ]
                  }
                ],
                "operationName": [
                  {
                    "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED",
                    "values": [
                      [
                        "value1",
                        "value2"
                      ]
                    ]
                  }
                ],
                "serviceName": [
                  {
                    "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED",
                    "values": [
                      [
                        "value1",
                        "value2"
                      ]
                    ]
                  }
                ],
                "spanFields": [
                  {
                    "filterType": {
                      "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED",
                      "values": [
                        [
                          "value1",
                          "value2"
                        ]
                      ]
                    },
                    "key": "span.field.key"
                  }
                ],
                "subsystemName": [
                  {
                    "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED",
                    "values": [
                      [
                        "value1",
                        "value2"
                      ]
                    ]
                  }
                ]
              }
            }
          },
          "notificationPayloadFilter": [
            [
              "obj.field"
            ]
          ]
        }
      },
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}
'

{
  "alertDefs": [
    {
      "alertDefProperties": {
        "name": "My Alert",
        "priority": "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED",
        "type": "ALERT_DEF_TYPE_LOGS_IMMEDIATE_OR_UNSPECIFIED",
        "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"
        },
        "notificationGroup": {
          "destinations": [
            {
              "connectorId": "connector_id_example",
              "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED",
              "presetId": "preset_id_example",
              "resolvedRouteOverrides": {
                "configOverrides": {
                  "connectorConfigFields": [
                    {
                      "fieldName": "description",
                      "template": "template_example"
                    }
                  ],
                  "messageConfigFields": [
                    {
                      "fieldName": "description",
                      "template": "template_example"
                    }
                  ],
                  "payloadType": "slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"
                }
              },
              "triggeredRoutingOverrides": {
                "configOverrides": {
                  "connectorConfigFields": [
                    {
                      "fieldName": "description",
                      "template": "template_example"
                    }
                  ],
                  "messageConfigFields": [
                    {
                      "fieldName": "description",
                      "template": "template_example"
                    }
                  ],
                  "payloadType": "slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"
                }
              }
            }
          ],
          "groupByKeys": [
            [
              "key1",
              "key2"
            ]
          ],
          "router": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
          },
          "webhooks": [
            {
              "integration": {
                "integrationId": 123
              },
              "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": {
                    "connectorConfigFields": [
                      {
                        "fieldName": "description",
                        "template": "template_example"
                      }
                    ],
                    "messageConfigFields": [
                      {
                        "fieldName": "description",
                        "template": "template_example"
                      }
                    ],
                    "payloadType": "slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"
                  }
                },
                "triggeredRoutingOverrides": {
                  "configOverrides": {
                    "connectorConfigFields": [
                      {
                        "fieldName": "description",
                        "template": "template_example"
                      }
                    ],
                    "messageConfigFields": [
                      {
                        "fieldName": "description",
                        "template": "template_example"
                      }
                    ],
                    "payloadType": "slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"
                  }
                }
              }
            ],
            "groupByKeys": [
              [
                "key1",
                "key2"
              ]
            ],
            "router": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
            },
            "webhooks": [
              {
                "integration": {
                  "integrationId": 123
                },
                "minutes": 15,
                "notifyOn": "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED"
              }
            ]
          }
        ],
        "phantomMode": false,
        "tracingImmediate": {
          "tracingFilter": {
            "simpleFilter": {
              "latencyThresholdMs": 1000,
              "tracingLabelFilters": {
                "applicationName": [
                  {
                    "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED",
                    "values": [
                      [
                        "value1",
                        "value2"
                      ]
                    ]
                  }
                ],
                "operationName": [
                  {
                    "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED",
                    "values": [
                      [
                        "value1",
                        "value2"
                      ]
                    ]
                  }
                ],
                "serviceName": [
                  {
                    "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED",
                    "values": [
                      [
                        "value1",
                        "value2"
                      ]
                    ]
                  }
                ],
                "spanFields": [
                  {
                    "filterType": {
                      "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED",
                      "values": [
                        [
                          "value1",
                          "value2"
                        ]
                      ]
                    },
                    "key": "span.field.key"
                  }
                ],
                "subsystemName": [
                  {
                    "operation": "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED",
                    "values": [
                      [
                        "value1",
                        "value2"
                      ]
                    ]
                  }
                ]
              }
            }
          },
          "notificationPayloadFilter": [
            [
              "obj.field"
            ]
          ]
        }
      },
      "alertVersionId": "<string>",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdTime": "2023-10-01T12:00:00.000Z",
      "lastTriggeredTime": "2023-10-01T12:00:00.000Z",
      "status": "ALERT_DEF_STATUS_UNSPECIFIED",
      "updatedTime": "2023-10-01T12:00:00.000Z"
    }
  ],
  "failedToReplaceAlertDefs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "notFoundIds": [
    [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  ],
  "skippedIds": [
    [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  ]
}

Authorizations

Authorization

string

header

required

API key authentication

Body

application/json

A request to bulk replace multiple alert definitions

alertDefsToReplace

Alert definition to replace · object[]

required

Show child attributes

alertDefsToReplace.alertDefProperties

Alert definition properties · 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

Show child attributes

alertDefsToReplace.alertDefProperties.name

string

required

The name of the alert definition

Example:

"My Alert"

alertDefsToReplace.alertDefProperties.priority

enum<string>

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

alertDefsToReplace.alertDefProperties.type

enum<string>

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

alertDefsToReplace.alertDefProperties.activeOn

Alert activity schedule · object

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

Show child attributes

alertDefsToReplace.alertDefProperties.activeOn.dayOfWeek

enum<string>[]

required

Available options:

DAY_OF_WEEK_MONDAY_OR_UNSPECIFIED,

DAY_OF_WEEK_TUESDAY,

DAY_OF_WEEK_WEDNESDAY,

DAY_OF_WEEK_THURSDAY,

DAY_OF_WEEK_FRIDAY,

DAY_OF_WEEK_SATURDAY,

DAY_OF_WEEK_SUNDAY

alertDefsToReplace.alertDefProperties.activeOn.endTime

Time of day · object

required

Represents a specific time in a 24-hour format

Show child attributes

alertDefsToReplace.alertDefProperties.activeOn.endTime.hours

integer<int32>

required

Example:

14

alertDefsToReplace.alertDefProperties.activeOn.endTime.minutes

integer<int32>

required

Example:

30

alertDefsToReplace.alertDefProperties.activeOn.startTime

Time of day · object

required

Represents a specific time in a 24-hour format

Show child attributes

alertDefsToReplace.alertDefProperties.activeOn.startTime.hours

integer<int32>

required

Example:

14

alertDefsToReplace.alertDefProperties.activeOn.startTime.minutes

integer<int32>

required

Example:

30

alertDefsToReplace.alertDefProperties.deleted

boolean

Whether the alert has been marked as deleted

Example:

false

alertDefsToReplace.alertDefProperties.description

string

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

Example:

"Alert description"

alertDefsToReplace.alertDefProperties.enabled

boolean

Whether the alert is currently active and monitoring

Example:

true

alertDefsToReplace.alertDefProperties.entityLabels

object

Labels used to identify and categorize the alert entity

Show child attributes

alertDefsToReplace.alertDefProperties.entityLabels.{key}

string

Example:

{ "key": "value" }

alertDefsToReplace.alertDefProperties.groupByKeys

string[]

Keys used to group and aggregate alert data

alertDefsToReplace.alertDefProperties.incidentsSettings

Alert definition incident settings · object

Show child attributes

alertDefsToReplace.alertDefProperties.incidentsSettings.minutes

integer<int64>

The time in minutes before the alert can be retriggered

Example:

30

alertDefsToReplace.alertDefProperties.incidentsSettings.notifyOn

enum<string>

Available options:

NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED,

NOTIFY_ON_TRIGGERED_AND_RESOLVED

alertDefsToReplace.alertDefProperties.notificationGroup

Alert definition notification group · object

Show child attributes

alertDefsToReplace.alertDefProperties.notificationGroup.destinations

Notification destination configuration · object[]

Show child attributes

alertDefsToReplace.alertDefProperties.notificationGroup.destinations.connectorId

string

required

The connector ID used to send notifications

Example:

"connector_id_example"

alertDefsToReplace.alertDefProperties.notificationGroup.destinations.notifyOn

enum<string>

Available options:

NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED,

NOTIFY_ON_TRIGGERED_AND_RESOLVED

alertDefsToReplace.alertDefProperties.notificationGroup.destinations.presetId

string

Optional preset ID for the notification destination

Example:

"preset_id_example"

alertDefsToReplace.alertDefProperties.notificationGroup.destinations.resolvedRouteOverrides

Notification routing · object

Show child attributes

alertDefsToReplace.alertDefProperties.notificationGroup.destinations.resolvedRouteOverrides.configOverrides

Source overrides · object

Show child attributes

alertDefsToReplace.alertDefProperties.notificationGroup.destinations.resolvedRouteOverrides.configOverrides.connectorConfigFields

Connector config field · object[]

required

Show child attributes

alertDefsToReplace.alertDefProperties.notificationGroup.destinations.resolvedRouteOverrides.configOverrides.connectorConfigFields.fieldName

string

required

The name of the configuration field

Example:

"description"

alertDefsToReplace.alertDefProperties.notificationGroup.destinations.resolvedRouteOverrides.configOverrides.connectorConfigFields.template

string

required

The template for the configuration field

Example:

"template_example"

alertDefsToReplace.alertDefProperties.notificationGroup.destinations.resolvedRouteOverrides.configOverrides.messageConfigFields

Message config field · object[]

required

Show child attributes

alertDefsToReplace.alertDefProperties.notificationGroup.destinations.resolvedRouteOverrides.configOverrides.messageConfigFields.fieldName

string

required

The name of the configuration field

Example:

"description"

alertDefsToReplace.alertDefProperties.notificationGroup.destinations.resolvedRouteOverrides.configOverrides.messageConfigFields.template

string

required

The template for the configuration field

Example:

"template_example"

alertDefsToReplace.alertDefProperties.notificationGroup.destinations.resolvedRouteOverrides.configOverrides.payloadType

string

required

the payload type for the notification

Example:

"slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"

alertDefsToReplace.alertDefProperties.notificationGroup.destinations.triggeredRoutingOverrides

Notification routing · object

Show child attributes

alertDefsToReplace.alertDefProperties.notificationGroup.destinations.triggeredRoutingOverrides.configOverrides

Source overrides · object

Show child attributes

alertDefsToReplace.alertDefProperties.notificationGroup.destinations.triggeredRoutingOverrides.configOverrides.connectorConfigFields

Connector config field · object[]

required

Show child attributes

alertDefsToReplace.alertDefProperties.notificationGroup.destinations.triggeredRoutingOverrides.configOverrides.connectorConfigFields.fieldName

string

required

The name of the configuration field

Example:

"description"

alertDefsToReplace.alertDefProperties.notificationGroup.destinations.triggeredRoutingOverrides.configOverrides.connectorConfigFields.template

string

required

The template for the configuration field

Example:

"template_example"

alertDefsToReplace.alertDefProperties.notificationGroup.destinations.triggeredRoutingOverrides.configOverrides.messageConfigFields

Message config field · object[]

required

Show child attributes

alertDefsToReplace.alertDefProperties.notificationGroup.destinations.triggeredRoutingOverrides.configOverrides.messageConfigFields.fieldName

string

required

The name of the configuration field

Example:

"description"

alertDefsToReplace.alertDefProperties.notificationGroup.destinations.triggeredRoutingOverrides.configOverrides.messageConfigFields.template

string

required

The template for the configuration field

Example:

"template_example"

alertDefsToReplace.alertDefProperties.notificationGroup.destinations.triggeredRoutingOverrides.configOverrides.payloadType

string

required

the payload type for the notification

Example:

"slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"

alertDefsToReplace.alertDefProperties.notificationGroup.groupByKeys

string[]

The keys to group the alerts by

alertDefsToReplace.alertDefProperties.notificationGroup.router

Notification router · object

Configuration for routing notifications

Show child attributes

alertDefsToReplace.alertDefProperties.notificationGroup.router.id

string

required

The ID of the notification router

Example:

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

alertDefsToReplace.alertDefProperties.notificationGroup.router.notifyOn

enum<string>

Available options:

NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED,

NOTIFY_ON_TRIGGERED_AND_RESOLVED

alertDefsToReplace.alertDefProperties.notificationGroup.webhooks

Alert definition webhook settings · object[]

Show child attributes

alertDefsToReplace.alertDefProperties.notificationGroup.webhooks.integration

Integration type · object

required

Defines the type of integration to use for notifications

Integration type
Integration type

Show child attributes

alertDefsToReplace.alertDefProperties.notificationGroup.webhooks.integration.integrationId

integer<int64>

The integration ID for the notification

Example:

123

alertDefsToReplace.alertDefProperties.notificationGroup.webhooks.minutes

integer<int64>

The time in minutes before the alert can be retriggered

Example:

15

alertDefsToReplace.alertDefProperties.notificationGroup.webhooks.notifyOn

enum<string>

Available options:

NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED,

NOTIFY_ON_TRIGGERED_AND_RESOLVED

alertDefsToReplace.alertDefProperties.notificationGroupExcess

Alert definition notification group · object[]

Show child attributes

alertDefsToReplace.alertDefProperties.notificationGroupExcess.destinations

Notification destination configuration · object[]

Show child attributes

alertDefsToReplace.alertDefProperties.notificationGroupExcess.destinations.connectorId

string

required

The connector ID used to send notifications

Example:

"connector_id_example"

alertDefsToReplace.alertDefProperties.notificationGroupExcess.destinations.notifyOn

enum<string>

Available options:

NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED,

NOTIFY_ON_TRIGGERED_AND_RESOLVED

alertDefsToReplace.alertDefProperties.notificationGroupExcess.destinations.presetId

string

Optional preset ID for the notification destination

Example:

"preset_id_example"

alertDefsToReplace.alertDefProperties.notificationGroupExcess.destinations.resolvedRouteOverrides

Notification routing · object

Show child attributes

alertDefsToReplace.alertDefProperties.notificationGroupExcess.destinations.resolvedRouteOverrides.configOverrides

Source overrides · object

Show child attributes

alertDefsToReplace.alertDefProperties.notificationGroupExcess.destinations.resolvedRouteOverrides.configOverrides.connectorConfigFields

Connector config field · object[]

required

Show child attributes

alertDefsToReplace.alertDefProperties.notificationGroupExcess.destinations.resolvedRouteOverrides.configOverrides.connectorConfigFields.fieldName

string

required

The name of the configuration field

Example:

"description"

alertDefsToReplace.alertDefProperties.notificationGroupExcess.destinations.resolvedRouteOverrides.configOverrides.connectorConfigFields.template

string

required

The template for the configuration field

Example:

"template_example"

alertDefsToReplace.alertDefProperties.notificationGroupExcess.destinations.resolvedRouteOverrides.configOverrides.messageConfigFields

Message config field · object[]

required

Show child attributes

alertDefsToReplace.alertDefProperties.notificationGroupExcess.destinations.resolvedRouteOverrides.configOverrides.messageConfigFields.fieldName

string

required

The name of the configuration field

Example:

"description"

alertDefsToReplace.alertDefProperties.notificationGroupExcess.destinations.resolvedRouteOverrides.configOverrides.messageConfigFields.template

string

required

The template for the configuration field

Example:

"template_example"

alertDefsToReplace.alertDefProperties.notificationGroupExcess.destinations.resolvedRouteOverrides.configOverrides.payloadType

string

required

the payload type for the notification

Example:

"slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"

alertDefsToReplace.alertDefProperties.notificationGroupExcess.destinations.triggeredRoutingOverrides

Notification routing · object

Show child attributes

alertDefsToReplace.alertDefProperties.notificationGroupExcess.destinations.triggeredRoutingOverrides.configOverrides

Source overrides · object

Show child attributes

alertDefsToReplace.alertDefProperties.notificationGroupExcess.destinations.triggeredRoutingOverrides.configOverrides.connectorConfigFields

Connector config field · object[]

required

Show child attributes

alertDefsToReplace.alertDefProperties.notificationGroupExcess.destinations.triggeredRoutingOverrides.configOverrides.connectorConfigFields.fieldName

string

required

The name of the configuration field

Example:

"description"

alertDefsToReplace.alertDefProperties.notificationGroupExcess.destinations.triggeredRoutingOverrides.configOverrides.connectorConfigFields.template

string

required

The template for the configuration field

Example:

"template_example"

alertDefsToReplace.alertDefProperties.notificationGroupExcess.destinations.triggeredRoutingOverrides.configOverrides.messageConfigFields

Message config field · object[]

required

Show child attributes

alertDefsToReplace.alertDefProperties.notificationGroupExcess.destinations.triggeredRoutingOverrides.configOverrides.messageConfigFields.fieldName

string

required

The name of the configuration field

Example:

"description"

alertDefsToReplace.alertDefProperties.notificationGroupExcess.destinations.triggeredRoutingOverrides.configOverrides.messageConfigFields.template

string

required

The template for the configuration field

Example:

"template_example"

alertDefsToReplace.alertDefProperties.notificationGroupExcess.destinations.triggeredRoutingOverrides.configOverrides.payloadType

string

required

the payload type for the notification

Example:

"slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"

alertDefsToReplace.alertDefProperties.notificationGroupExcess.groupByKeys

string[]

The keys to group the alerts by

alertDefsToReplace.alertDefProperties.notificationGroupExcess.router

Notification router · object

Configuration for routing notifications

Show child attributes

alertDefsToReplace.alertDefProperties.notificationGroupExcess.router.id

string

required

The ID of the notification router

Example:

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

alertDefsToReplace.alertDefProperties.notificationGroupExcess.router.notifyOn

enum<string>

Available options:

NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED,

NOTIFY_ON_TRIGGERED_AND_RESOLVED

alertDefsToReplace.alertDefProperties.notificationGroupExcess.webhooks

Alert definition webhook settings · object[]

Show child attributes

alertDefsToReplace.alertDefProperties.notificationGroupExcess.webhooks.integration

Integration type · object

required

Defines the type of integration to use for notifications

Integration type
Integration type

Show child attributes

alertDefsToReplace.alertDefProperties.notificationGroupExcess.webhooks.integration.integrationId

integer<int64>

The integration ID for the notification

Example:

123

alertDefsToReplace.alertDefProperties.notificationGroupExcess.webhooks.minutes

integer<int64>

The time in minutes before the alert can be retriggered

Example:

15

alertDefsToReplace.alertDefProperties.notificationGroupExcess.webhooks.notifyOn

enum<string>

Available options:

NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED,

NOTIFY_ON_TRIGGERED_AND_RESOLVED

alertDefsToReplace.alertDefProperties.phantomMode

boolean

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

Example:

false

alertDefsToReplace.alertDefProperties.tracingImmediate

Trace-based immediate alert type · object

Configuration for immediate alerts triggered on trace entries

Show child attributes

alertDefsToReplace.alertDefProperties.tracingImmediate.tracingFilter

Tracing filter · object

required

Filter configuration for tracing-based alerts

Show child attributes

alertDefsToReplace.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter

Simple tracing filter · object

Basic filter configuration using a latency threshold and label filters

Show child attributes

alertDefsToReplace.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.latencyThresholdMs

string<uint64>

required

The latency threshold to filter traces in milliseconds

Example:

1000

alertDefsToReplace.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters

Tracing label filters · object

Filters for application name, subsystem name, service name, operation name and span fields

Show child attributes

alertDefsToReplace.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.applicationName

Tracing filter type · object[]

Show child attributes

alertDefsToReplace.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.applicationName.operation

enum<string>

required

Available options:

TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED,

TRACING_FILTER_OPERATION_TYPE_INCLUDES,

TRACING_FILTER_OPERATION_TYPE_ENDS_WITH,

TRACING_FILTER_OPERATION_TYPE_STARTS_WITH,

TRACING_FILTER_OPERATION_TYPE_IS_NOT

alertDefsToReplace.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.applicationName.values

string[]

required

The values of the label to filter by

alertDefsToReplace.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.operationName

Tracing filter type · object[]

Show child attributes

alertDefsToReplace.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.operationName.operation

enum<string>

required

Available options:

TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED,

TRACING_FILTER_OPERATION_TYPE_INCLUDES,

TRACING_FILTER_OPERATION_TYPE_ENDS_WITH,

TRACING_FILTER_OPERATION_TYPE_STARTS_WITH,

TRACING_FILTER_OPERATION_TYPE_IS_NOT

alertDefsToReplace.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.operationName.values

string[]

required

The values of the label to filter by

alertDefsToReplace.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.serviceName

Tracing filter type · object[]

Show child attributes

alertDefsToReplace.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.serviceName.operation

enum<string>

required

Available options:

TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED,

TRACING_FILTER_OPERATION_TYPE_INCLUDES,

TRACING_FILTER_OPERATION_TYPE_ENDS_WITH,

TRACING_FILTER_OPERATION_TYPE_STARTS_WITH,

TRACING_FILTER_OPERATION_TYPE_IS_NOT

alertDefsToReplace.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.serviceName.values

string[]

required

The values of the label to filter by

alertDefsToReplace.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.spanFields

Tracing span fields filter type · object[]

Show child attributes

alertDefsToReplace.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.spanFields.filterType

Tracing filter type · object

required

Filter type for trace entries

Show child attributes

alertDefsToReplace.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.spanFields.filterType.operation

enum<string>

required

Available options:

TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED,

TRACING_FILTER_OPERATION_TYPE_INCLUDES,

TRACING_FILTER_OPERATION_TYPE_ENDS_WITH,

TRACING_FILTER_OPERATION_TYPE_STARTS_WITH,

TRACING_FILTER_OPERATION_TYPE_IS_NOT

alertDefsToReplace.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.spanFields.filterType.values

string[]

required

The values of the label to filter by

alertDefsToReplace.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.spanFields.key

string

required

The key of the span field to filter by

Example:

"span.field.key"

alertDefsToReplace.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.subsystemName

Tracing filter type · object[]

Show child attributes

alertDefsToReplace.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.subsystemName.operation

enum<string>

required

Available options:

TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED,

TRACING_FILTER_OPERATION_TYPE_INCLUDES,

TRACING_FILTER_OPERATION_TYPE_ENDS_WITH,

TRACING_FILTER_OPERATION_TYPE_STARTS_WITH,

TRACING_FILTER_OPERATION_TYPE_IS_NOT

alertDefsToReplace.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.subsystemName.values

string[]

required

The values of the label to filter by

alertDefsToReplace.alertDefProperties.tracingImmediate.notificationPayloadFilter

string[]

Notification payload field filter

alertDefsToReplace.id

string

required

The alert definition ID

Example:

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

Response

A response that contains the results of the bulk replace operation

alertDefs

Alert definition · object[]

required

Show child attributes

alertDefs.alertDefProperties

Alert definition properties · 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

Show child attributes

alertDefs.alertDefProperties.name

string

required

The name of the alert definition

Example:

"My Alert"

alertDefs.alertDefProperties.priority

enum<string>

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

alertDefs.alertDefProperties.type

enum<string>

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

alertDefs.alertDefProperties.activeOn

Alert activity schedule · object

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

Show child attributes

alertDefs.alertDefProperties.activeOn.dayOfWeek

enum<string>[]

required

Available options:

DAY_OF_WEEK_MONDAY_OR_UNSPECIFIED,

DAY_OF_WEEK_TUESDAY,

DAY_OF_WEEK_WEDNESDAY,

DAY_OF_WEEK_THURSDAY,

DAY_OF_WEEK_FRIDAY,

DAY_OF_WEEK_SATURDAY,

DAY_OF_WEEK_SUNDAY

alertDefs.alertDefProperties.activeOn.endTime

Time of day · object

required

Represents a specific time in a 24-hour format

Show child attributes

alertDefs.alertDefProperties.activeOn.endTime.hours

integer<int32>

required

Example:

14

alertDefs.alertDefProperties.activeOn.endTime.minutes

integer<int32>

required

Example:

30

alertDefs.alertDefProperties.activeOn.startTime

Time of day · object

required

Represents a specific time in a 24-hour format

Show child attributes

alertDefs.alertDefProperties.activeOn.startTime.hours

integer<int32>

required

Example:

14

alertDefs.alertDefProperties.activeOn.startTime.minutes

integer<int32>

required

Example:

30

alertDefs.alertDefProperties.deleted

boolean

Whether the alert has been marked as deleted

Example:

false

alertDefs.alertDefProperties.description

string

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

Example:

"Alert description"

alertDefs.alertDefProperties.enabled

boolean

Whether the alert is currently active and monitoring

Example:

true

alertDefs.alertDefProperties.entityLabels

object

Labels used to identify and categorize the alert entity

Show child attributes

alertDefs.alertDefProperties.entityLabels.{key}

string

Example:

{ "key": "value" }

alertDefs.alertDefProperties.groupByKeys

string[]

Keys used to group and aggregate alert data

alertDefs.alertDefProperties.incidentsSettings

Alert definition incident settings · object

Show child attributes

alertDefs.alertDefProperties.incidentsSettings.minutes

integer<int64>

The time in minutes before the alert can be retriggered

Example:

30

alertDefs.alertDefProperties.incidentsSettings.notifyOn

enum<string>

Available options:

NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED,

NOTIFY_ON_TRIGGERED_AND_RESOLVED

alertDefs.alertDefProperties.notificationGroup

Alert definition notification group · object

Show child attributes

alertDefs.alertDefProperties.notificationGroup.destinations

Notification destination configuration · object[]

Show child attributes

alertDefs.alertDefProperties.notificationGroup.destinations.connectorId

string

required

The connector ID used to send notifications

Example:

"connector_id_example"

alertDefs.alertDefProperties.notificationGroup.destinations.notifyOn

enum<string>

Available options:

NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED,

NOTIFY_ON_TRIGGERED_AND_RESOLVED

alertDefs.alertDefProperties.notificationGroup.destinations.presetId

string

Optional preset ID for the notification destination

Example:

"preset_id_example"

alertDefs.alertDefProperties.notificationGroup.destinations.resolvedRouteOverrides

Notification routing · object

Show child attributes

alertDefs.alertDefProperties.notificationGroup.destinations.resolvedRouteOverrides.configOverrides

Source overrides · object

Show child attributes

alertDefs.alertDefProperties.notificationGroup.destinations.resolvedRouteOverrides.configOverrides.connectorConfigFields

Connector config field · object[]

required

Show child attributes

alertDefs.alertDefProperties.notificationGroup.destinations.resolvedRouteOverrides.configOverrides.connectorConfigFields.fieldName

string

required

The name of the configuration field

Example:

"description"

alertDefs.alertDefProperties.notificationGroup.destinations.resolvedRouteOverrides.configOverrides.connectorConfigFields.template

string

required

The template for the configuration field

Example:

"template_example"

alertDefs.alertDefProperties.notificationGroup.destinations.resolvedRouteOverrides.configOverrides.messageConfigFields

Message config field · object[]

required

Show child attributes

alertDefs.alertDefProperties.notificationGroup.destinations.resolvedRouteOverrides.configOverrides.messageConfigFields.fieldName

string

required

The name of the configuration field

Example:

"description"

alertDefs.alertDefProperties.notificationGroup.destinations.resolvedRouteOverrides.configOverrides.messageConfigFields.template

string

required

The template for the configuration field

Example:

"template_example"

alertDefs.alertDefProperties.notificationGroup.destinations.resolvedRouteOverrides.configOverrides.payloadType

string

required

the payload type for the notification

Example:

"slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"

alertDefs.alertDefProperties.notificationGroup.destinations.triggeredRoutingOverrides

Notification routing · object

Show child attributes

alertDefs.alertDefProperties.notificationGroup.destinations.triggeredRoutingOverrides.configOverrides

Source overrides · object

Show child attributes

alertDefs.alertDefProperties.notificationGroup.destinations.triggeredRoutingOverrides.configOverrides.connectorConfigFields

Connector config field · object[]

required

Show child attributes

alertDefs.alertDefProperties.notificationGroup.destinations.triggeredRoutingOverrides.configOverrides.connectorConfigFields.fieldName

string

required

The name of the configuration field

Example:

"description"

alertDefs.alertDefProperties.notificationGroup.destinations.triggeredRoutingOverrides.configOverrides.connectorConfigFields.template

string

required

The template for the configuration field

Example:

"template_example"

alertDefs.alertDefProperties.notificationGroup.destinations.triggeredRoutingOverrides.configOverrides.messageConfigFields

Message config field · object[]

required

Show child attributes

alertDefs.alertDefProperties.notificationGroup.destinations.triggeredRoutingOverrides.configOverrides.messageConfigFields.fieldName

string

required

The name of the configuration field

Example:

"description"

alertDefs.alertDefProperties.notificationGroup.destinations.triggeredRoutingOverrides.configOverrides.messageConfigFields.template

string

required

The template for the configuration field

Example:

"template_example"

alertDefs.alertDefProperties.notificationGroup.destinations.triggeredRoutingOverrides.configOverrides.payloadType

string

required

the payload type for the notification

Example:

"slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"

alertDefs.alertDefProperties.notificationGroup.groupByKeys

string[]

The keys to group the alerts by

alertDefs.alertDefProperties.notificationGroup.router

Notification router · object

Configuration for routing notifications

Show child attributes

alertDefs.alertDefProperties.notificationGroup.router.id

string

required

The ID of the notification router

Example:

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

alertDefs.alertDefProperties.notificationGroup.router.notifyOn

enum<string>

Available options:

NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED,

NOTIFY_ON_TRIGGERED_AND_RESOLVED

alertDefs.alertDefProperties.notificationGroup.webhooks

Alert definition webhook settings · object[]

Show child attributes

alertDefs.alertDefProperties.notificationGroup.webhooks.integration

Integration type · object

required

Defines the type of integration to use for notifications

Integration type
Integration type

Show child attributes

alertDefs.alertDefProperties.notificationGroup.webhooks.integration.integrationId

integer<int64>

The integration ID for the notification

Example:

123

alertDefs.alertDefProperties.notificationGroup.webhooks.minutes

integer<int64>

The time in minutes before the alert can be retriggered

Example:

15

alertDefs.alertDefProperties.notificationGroup.webhooks.notifyOn

enum<string>

Available options:

NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED,

NOTIFY_ON_TRIGGERED_AND_RESOLVED

alertDefs.alertDefProperties.notificationGroupExcess

Alert definition notification group · object[]

Show child attributes

alertDefs.alertDefProperties.notificationGroupExcess.destinations

Notification destination configuration · object[]

Show child attributes

alertDefs.alertDefProperties.notificationGroupExcess.destinations.connectorId

string

required

The connector ID used to send notifications

Example:

"connector_id_example"

alertDefs.alertDefProperties.notificationGroupExcess.destinations.notifyOn

enum<string>

Available options:

NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED,

NOTIFY_ON_TRIGGERED_AND_RESOLVED

alertDefs.alertDefProperties.notificationGroupExcess.destinations.presetId

string

Optional preset ID for the notification destination

Example:

"preset_id_example"

alertDefs.alertDefProperties.notificationGroupExcess.destinations.resolvedRouteOverrides

Notification routing · object

Show child attributes

alertDefs.alertDefProperties.notificationGroupExcess.destinations.resolvedRouteOverrides.configOverrides

Source overrides · object

Show child attributes

alertDefs.alertDefProperties.notificationGroupExcess.destinations.resolvedRouteOverrides.configOverrides.connectorConfigFields

Connector config field · object[]

required

Show child attributes

alertDefs.alertDefProperties.notificationGroupExcess.destinations.resolvedRouteOverrides.configOverrides.connectorConfigFields.fieldName

string

required

The name of the configuration field

Example:

"description"

alertDefs.alertDefProperties.notificationGroupExcess.destinations.resolvedRouteOverrides.configOverrides.connectorConfigFields.template

string

required

The template for the configuration field

Example:

"template_example"

alertDefs.alertDefProperties.notificationGroupExcess.destinations.resolvedRouteOverrides.configOverrides.messageConfigFields

Message config field · object[]

required

Show child attributes

alertDefs.alertDefProperties.notificationGroupExcess.destinations.resolvedRouteOverrides.configOverrides.messageConfigFields.fieldName

string

required

The name of the configuration field

Example:

"description"

alertDefs.alertDefProperties.notificationGroupExcess.destinations.resolvedRouteOverrides.configOverrides.messageConfigFields.template

string

required

The template for the configuration field

Example:

"template_example"

alertDefs.alertDefProperties.notificationGroupExcess.destinations.resolvedRouteOverrides.configOverrides.payloadType

string

required

the payload type for the notification

Example:

"slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"

alertDefs.alertDefProperties.notificationGroupExcess.destinations.triggeredRoutingOverrides

Notification routing · object

Show child attributes

alertDefs.alertDefProperties.notificationGroupExcess.destinations.triggeredRoutingOverrides.configOverrides

Source overrides · object

Show child attributes

alertDefs.alertDefProperties.notificationGroupExcess.destinations.triggeredRoutingOverrides.configOverrides.connectorConfigFields

Connector config field · object[]

required

Show child attributes

alertDefs.alertDefProperties.notificationGroupExcess.destinations.triggeredRoutingOverrides.configOverrides.connectorConfigFields.fieldName

string

required

The name of the configuration field

Example:

"description"

alertDefs.alertDefProperties.notificationGroupExcess.destinations.triggeredRoutingOverrides.configOverrides.connectorConfigFields.template

string

required

The template for the configuration field

Example:

"template_example"

alertDefs.alertDefProperties.notificationGroupExcess.destinations.triggeredRoutingOverrides.configOverrides.messageConfigFields

Message config field · object[]

required

Show child attributes

alertDefs.alertDefProperties.notificationGroupExcess.destinations.triggeredRoutingOverrides.configOverrides.messageConfigFields.fieldName

string

required

The name of the configuration field

Example:

"description"

alertDefs.alertDefProperties.notificationGroupExcess.destinations.triggeredRoutingOverrides.configOverrides.messageConfigFields.template

string

required

The template for the configuration field

Example:

"template_example"

alertDefs.alertDefProperties.notificationGroupExcess.destinations.triggeredRoutingOverrides.configOverrides.payloadType

string

required

the payload type for the notification

Example:

"slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"

alertDefs.alertDefProperties.notificationGroupExcess.groupByKeys

string[]

The keys to group the alerts by

alertDefs.alertDefProperties.notificationGroupExcess.router

Notification router · object

Configuration for routing notifications

Show child attributes

alertDefs.alertDefProperties.notificationGroupExcess.router.id

string

required

The ID of the notification router

Example:

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

alertDefs.alertDefProperties.notificationGroupExcess.router.notifyOn

enum<string>

Available options:

NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED,

NOTIFY_ON_TRIGGERED_AND_RESOLVED

alertDefs.alertDefProperties.notificationGroupExcess.webhooks

Alert definition webhook settings · object[]

Show child attributes

alertDefs.alertDefProperties.notificationGroupExcess.webhooks.integration

Integration type · object

required

Defines the type of integration to use for notifications

Integration type
Integration type

Show child attributes

alertDefs.alertDefProperties.notificationGroupExcess.webhooks.integration.integrationId

integer<int64>

The integration ID for the notification

Example:

123

alertDefs.alertDefProperties.notificationGroupExcess.webhooks.minutes

integer<int64>

The time in minutes before the alert can be retriggered

Example:

15

alertDefs.alertDefProperties.notificationGroupExcess.webhooks.notifyOn

enum<string>

Available options:

NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED,

NOTIFY_ON_TRIGGERED_AND_RESOLVED

alertDefs.alertDefProperties.phantomMode

boolean

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

Example:

false

alertDefs.alertDefProperties.tracingImmediate

Trace-based immediate alert type · object

Configuration for immediate alerts triggered on trace entries

Show child attributes

alertDefs.alertDefProperties.tracingImmediate.tracingFilter

Tracing filter · object

required

Filter configuration for tracing-based alerts

Show child attributes

alertDefs.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter

Simple tracing filter · object

Basic filter configuration using a latency threshold and label filters

Show child attributes

alertDefs.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.latencyThresholdMs

string<uint64>

required

The latency threshold to filter traces in milliseconds

Example:

1000

alertDefs.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters

Tracing label filters · object

Filters for application name, subsystem name, service name, operation name and span fields

Show child attributes

alertDefs.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.applicationName

Tracing filter type · object[]

Show child attributes

alertDefs.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.applicationName.operation

enum<string>

required

Available options:

TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED,

TRACING_FILTER_OPERATION_TYPE_INCLUDES,

TRACING_FILTER_OPERATION_TYPE_ENDS_WITH,

TRACING_FILTER_OPERATION_TYPE_STARTS_WITH,

TRACING_FILTER_OPERATION_TYPE_IS_NOT

alertDefs.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.applicationName.values

string[]

required

The values of the label to filter by

alertDefs.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.operationName

Tracing filter type · object[]

Show child attributes

alertDefs.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.operationName.operation

enum<string>

required

Available options:

TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED,

TRACING_FILTER_OPERATION_TYPE_INCLUDES,

TRACING_FILTER_OPERATION_TYPE_ENDS_WITH,

TRACING_FILTER_OPERATION_TYPE_STARTS_WITH,

TRACING_FILTER_OPERATION_TYPE_IS_NOT

alertDefs.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.operationName.values

string[]

required

The values of the label to filter by

alertDefs.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.serviceName

Tracing filter type · object[]

Show child attributes

alertDefs.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.serviceName.operation

enum<string>

required

Available options:

TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED,

TRACING_FILTER_OPERATION_TYPE_INCLUDES,

TRACING_FILTER_OPERATION_TYPE_ENDS_WITH,

TRACING_FILTER_OPERATION_TYPE_STARTS_WITH,

TRACING_FILTER_OPERATION_TYPE_IS_NOT

alertDefs.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.serviceName.values

string[]

required

The values of the label to filter by

alertDefs.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.spanFields

Tracing span fields filter type · object[]

Show child attributes

alertDefs.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.spanFields.filterType

Tracing filter type · object

required

Filter type for trace entries

Show child attributes

alertDefs.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.spanFields.filterType.operation

enum<string>

required

Available options:

TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED,

TRACING_FILTER_OPERATION_TYPE_INCLUDES,

TRACING_FILTER_OPERATION_TYPE_ENDS_WITH,

TRACING_FILTER_OPERATION_TYPE_STARTS_WITH,

TRACING_FILTER_OPERATION_TYPE_IS_NOT

alertDefs.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.spanFields.filterType.values

string[]

required

The values of the label to filter by

alertDefs.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.spanFields.key

string

required

The key of the span field to filter by

Example:

"span.field.key"

alertDefs.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.subsystemName

Tracing filter type · object[]

Show child attributes

alertDefs.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.subsystemName.operation

enum<string>

required

Available options:

TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED,

TRACING_FILTER_OPERATION_TYPE_INCLUDES,

TRACING_FILTER_OPERATION_TYPE_ENDS_WITH,

TRACING_FILTER_OPERATION_TYPE_STARTS_WITH,

TRACING_FILTER_OPERATION_TYPE_IS_NOT

alertDefs.alertDefProperties.tracingImmediate.tracingFilter.simpleFilter.tracingLabelFilters.subsystemName.values

string[]

required

The values of the label to filter by

alertDefs.alertDefProperties.tracingImmediate.notificationPayloadFilter

string[]

Notification payload field filter

alertDefs.alertVersionId

string

required

The old alert ID

alertDefs.id

string

required

The alert definition's persistent ID

Example:

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

alertDefs.createdTime

string<date-time>

The time when the alert definition was created

Example:

"2023-10-01T12:00:00.000Z"

alertDefs.lastTriggeredTime

string<date-time>

The last time the alert definition was triggered

Example:

"2023-10-01T12:00:00.000Z"

alertDefs.status

enum<string>

Available options:

ALERT_DEF_STATUS_UNSPECIFIED,

ALERT_DEF_STATUS_ALERTING,

ALERT_DEF_STATUS_OK,

ALERT_DEF_STATUS_NO_DATA

alertDefs.updatedTime

string<date-time>

The time when the alert definition was last updated

Example:

"2023-10-01T12:00:00.000Z"

failedToReplaceAlertDefs

Failed to replace alert definition · object[]

required

Show child attributes

failedToReplaceAlertDefs.id

string

required

The alert definition ID

Example:

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

notFoundIds

string[]

required

List of alert definition IDs that were not found

skippedIds

string[]

required

List of alert definition IDs that were skipped (no changes detected)

Overview Create an alert

⌘I

Introduction

Use Cases

Actions Service

Alert Definitions Service

Alert Events Service

API Keys Service

Contextual Data Integration Service

Custom Enrichments Service

Dashboard Folders Service

Dashboard Service

Data Usage Service

Enrichments Service

Events Service

Events2Metrics Service

Extension Deployment Service

Extension Service

Extension Testing Service

Folders for Views

Incidents Service

Integration Service

IP Access Service

Outgoing Webhooks Service

Retentions Service

SAML Configuration Service

Scopes Service

Slos Service

Target Service

Team Permissions Management Service

Views

Bulk replace alert definitions

Authorizations

Body

Response