curl --request GET \
--url https://api.coralogix.com/mgmt/openapi/latest/alerts/alerts-general/v3/{id} \
--header 'Authorization: <api-key>'{
"alertDef": {
"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"
}
}No description available
curl --request GET \
--url https://api.coralogix.com/mgmt/openapi/latest/alerts/alerts-general/v3/{id} \
--header 'Authorization: <api-key>'{
"alertDef": {
"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"
}
}API key authentication
Alert definition ID
"123e4567-e89b-12d3-a456-426614174000"
A response containing the requested alert definition
This data structure represents an alert definition
Show child attributes
User-configurable properties of an alert definition
Show child attributes
The name of the alert definition
"My Alert"
ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED, ALERT_DEF_PRIORITY_P4, ALERT_DEF_PRIORITY_P3, ALERT_DEF_PRIORITY_P2, ALERT_DEF_PRIORITY_P1 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 Defines when an alert should be active based on days of the week and time windows
Show child attributes
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 Whether the alert has been marked as deleted
false
A detailed description of what the alert monitors and when it triggers
"Alert description"
Whether the alert is currently active and monitoring
true
Keys used to group and aggregate alert data
Show child attributes
Show child attributes
Show child attributes
The connector ID used to send notifications
"connector_id_example"
NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED, NOTIFY_ON_TRIGGERED_AND_RESOLVED Optional preset ID for the notification destination
"preset_id_example"
Show child attributes
Show child attributes
Show child attributes
The name of the configuration field
"description"
The template for the configuration field
"template_example"
Show child attributes
The name of the configuration field
"description"
The template for the configuration field
"template_example"
the payload type for the notification
"slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"
Show child attributes
Show child attributes
Show child attributes
The name of the configuration field
"description"
The template for the configuration field
"template_example"
Show child attributes
The name of the configuration field
"description"
The template for the configuration field
"template_example"
the payload type for the notification
"slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"
The keys to group the alerts by
Configuration for routing notifications
Show child attributes
The ID of the notification router
"123e4567-e89b-12d3-a456-426614174000"
NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED, NOTIFY_ON_TRIGGERED_AND_RESOLVED Show child attributes
Defines the type of integration to use for notifications
Show child attributes
The integration ID for the notification
123
The time in minutes before the alert can be retriggered
15
NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED, NOTIFY_ON_TRIGGERED_AND_RESOLVED Show child attributes
Show child attributes
The connector ID used to send notifications
"connector_id_example"
NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED, NOTIFY_ON_TRIGGERED_AND_RESOLVED Optional preset ID for the notification destination
"preset_id_example"
Show child attributes
Show child attributes
Show child attributes
The name of the configuration field
"description"
The template for the configuration field
"template_example"
Show child attributes
The name of the configuration field
"description"
The template for the configuration field
"template_example"
the payload type for the notification
"slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"
Show child attributes
Show child attributes
Show child attributes
The name of the configuration field
"description"
The template for the configuration field
"template_example"
Show child attributes
The name of the configuration field
"description"
The template for the configuration field
"template_example"
the payload type for the notification
"slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default"
The keys to group the alerts by
Configuration for routing notifications
Show child attributes
The ID of the notification router
"123e4567-e89b-12d3-a456-426614174000"
NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED, NOTIFY_ON_TRIGGERED_AND_RESOLVED Show child attributes
Defines the type of integration to use for notifications
Show child attributes
The integration ID for the notification
123
The time in minutes before the alert can be retriggered
15
NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED, NOTIFY_ON_TRIGGERED_AND_RESOLVED Whether the alert is in phantom mode (creating incidents or not)
false
Configuration for immediate alerts triggered on trace entries
Show child attributes
Filter configuration for tracing-based alerts
Show child attributes
Basic filter configuration using a latency threshold and label filters
Show child attributes
The latency threshold to filter traces in milliseconds
1000
Filters for application name, subsystem name, service name, operation name and span fields
Show child attributes
Show child attributes
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 The values of the label to filter by
Show child attributes
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 The values of the label to filter by
Show child attributes
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 The values of the label to filter by
Show child attributes
Filter type for trace entries
Show child attributes
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 The values of the label to filter by
The key of the span field to filter by
"span.field.key"
Show child attributes
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 The values of the label to filter by
Notification payload field filter
The old alert ID
The alert definition's persistent ID
"123e4567-e89b-12d3-a456-426614174000"
The time when the alert definition was created
"2023-10-01T12:00:00.000Z"
The last time the alert definition was triggered
"2023-10-01T12:00:00.000Z"
ALERT_DEF_STATUS_UNSPECIFIED, ALERT_DEF_STATUS_ALERTING, ALERT_DEF_STATUS_OK, ALERT_DEF_STATUS_NO_DATA The time when the alert definition was last updated
"2023-10-01T12:00:00.000Z"
Was this page helpful?