> ## Documentation Index > Fetch the complete documentation index at: https://docs.coralogix.com/llms.txt > Use this file to discover all available pages before exploring further. # Replace an alert definition > No description available ## OpenAPI ````yaml openapi_v3.yaml put /alerts/alerts-general/v3 openapi: 3.0.0 info: title: '' version: 1.0.0 servers: - url: https://api.coralogix.com/mgmt/openapi/3 - url: https://api.eu2.coralogix.com/mgmt/openapi/3 - url: https://api.coralogix.us/mgmt/openapi/3 - url: https://api.cx498.coralogix.com/mgmt/openapi/3 - url: https://api.coralogix.in/mgmt/openapi/3 - url: https://api.coralogixsg.com/mgmt/openapi/3 - url: https://api.ap3.coralogix.com/mgmt/openapi/3 security: - apiKeyAuth: [] tags: - name: Alert definitions service description: >- View and manage your alerts using alert definitions - data structures that contain the configuration required to create an alert. externalDocs: description: Learn more about alerts in our documentation url: https://coralogix.com/docs/user-guides/alerting/introduction-to-alerts/ - name: Metrics Data Archive Service description: View and manage your storage targets for metrics. externalDocs: description: Find out more about archives url: >- https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/ - name: Connectors service description: >- View and manage your connectors - integration instances for notification destinations externalDocs: description: Lean more about connectors in our documentation url: >- https://coralogix.com/docs/user-guides/notification-center/connectors/introduction/ - name: Cases service description: >- Manage cases throughout their lifecycle. Create, view, assign, acknowledge, resolve, and close cases to streamline investigations and follow-ups. externalDocs: description: Learn more about Cases in our documentation url: https://coralogix.com/docs/user-guides/cases/ - name: SAML Configuration Service description: Manage your SAML configuration externalDocs: url: '' - name: Events2Metrics Service description: Manage your events2metrics. externalDocs: url: '' - name: Presets service description: >- View and manage your presets - pre-configured templates for notification content rendering externalDocs: description: Lean more about presets in our documentation url: >- https://coralogix.com/docs/user-guides/notification-center/presets/introduction/ - name: Entities service description: Query information about registered entities in the notification center externalDocs: description: Lean more about the notification center in our documentation url: https://coralogix.com/docs/user-guides/notification-center/introduction/ - name: API Keys Service description: Manage your API Keys. externalDocs: url: '' - name: Alert events service description: >- Get information regarding your alert events - instances of alerts being triggered. externalDocs: description: Learn more about alert events and incidents in our documentation. url: https://coralogix.com/docs/user-guides/alerting/incidents/ - name: Scopes Service description: A service to manage scopes externalDocs: url: '' - name: IP access service description: >- IP access service provides the API for managing company IP access settings. externalDocs: url: '' - name: Dashboard service description: Get information about the Coralogix Dashboard catalog. externalDocs: url: '' - name: Events Service description: A service for querying events. externalDocs: description: Learn more about alerts in our documentation url: https://coralogix.com/docs/user-guides/alerting/introduction-to-alerts/ - name: Team Permissions Management Service description: Manage Team Groups. externalDocs: url: '' - name: Extension service description: A service that enables querying for extension information. externalDocs: description: Learn more about extensions in our documentation. url: https://coralogix.com/docs/integrations/extensions/ - name: Extension testing service externalDocs: description: Find out more about extensions in our documentation. url: https://coralogix.com/docs/integrations/extensions/ - name: Data Usage Service description: A service to manage data usage metrics. externalDocs: url: '' - name: Target Service description: View and manage your storage targets for logs. externalDocs: description: Find out more about archives url: >- https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/ - name: Contextual data integration service description: Query for contextual data integration information. externalDocs: url: '' - name: Custom Enrichments Service description: Manage your enrichments. externalDocs: url: '' - name: Global routers service description: >- View and manage your global routers - entities that direct notifications to configured destinations based on conditions externalDocs: description: Lean more about global routers in our documentation url: >- https://coralogix.com/docs/user-guides/notification-center/routing/introduction/ - name: Recording Rules Service description: A service to manage recording rules. externalDocs: url: '' - name: Folders for views service description: Create and manage view folders. externalDocs: url: '' - name: Incidents service description: >- Handle all operations related to incident management within Coralogix. Identify, manage, and resolve incidents efficiently through automated workflows and team collaboration. externalDocs: description: Find out more about incident management in our documentation url: https://coralogix.com/docs/user-guides/alerting/incidents/ - name: Retentions Service description: View and manage retentions externalDocs: url: '' - name: Extension deployment service description: A service that enables querying for extension deployment information. externalDocs: description: Find out more about extensions in our documentation. url: https://coralogix.com/docs/integrations/extensions/ - name: Enrichments Service description: Manage your enrichments. externalDocs: url: '' - name: Role Management Service description: Service for managing system and custom roles. externalDocs: url: '' - name: Integration service description: A service that enables querying for integration information. externalDocs: description: Find out more about integrations in our documentation. url: https://coralogix.com/docs/integrations/getting-started/ - name: Rule Groups Service description: A service to manage rule groups. externalDocs: url: '' - name: Policies Service description: View and manage your TCO policies externalDocs: url: '' - name: Alert Scheduler Rule service description: Manage your alert scheduler rules. externalDocs: url: '' - name: Dashboard folders service description: Manage your dashboard folders. externalDocs: url: '' - name: Actions Service description: A service for managing actions. externalDocs: url: '' - name: Slos Service description: A service for managing Service Level Objectives (SLOs). externalDocs: url: '' - name: Views service description: Create and manage views. externalDocs: url: '' - name: Outgoing webhooks service externalDocs: description: Find out more about outbound webhooks in our documentation. url: >- https://coralogix.com/docs/user-guides/alerting/outbound-webhooks/generic-outbound-webhooks-alert-webhooks/ - name: SLO Service description: Manage your SLOs. externalDocs: url: '' paths: /alerts/alerts-general/v3: put: tags: - Alert definitions service summary: Replace an alert definition description: No description available operationId: AlertDefsService_ReplaceAlertDef requestBody: content: application/json: schema: additionalProperties: false description: A request to replace an existing alert definition properties: alertDefProperties: $ref: '#/components/schemas/AlertDefProperties' id: type: string description: Alert definition ID example: 123e4567-e89b-12d3-a456-426614174000 title: Replace alert definition request type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReplaceAlertDefResponse' description: '' '400': content: application/json: {} description: Bad Request '401': content: application/json: {} description: Unauthorized request '500': content: application/json: {} description: Internal server error externalDocs: url: '' components: schemas: AlertDefProperties: oneOf: - $ref: '#/components/schemas/AlertDefPropertiesLogsImmediate' - $ref: '#/components/schemas/AlertDefPropertiesLogsThreshold' - $ref: '#/components/schemas/AlertDefPropertiesLogsRatioThreshold' - $ref: '#/components/schemas/AlertDefPropertiesMetricThreshold' - $ref: '#/components/schemas/AlertDefPropertiesFlow' - $ref: '#/components/schemas/AlertDefPropertiesLogsAnomaly' - $ref: '#/components/schemas/AlertDefPropertiesMetricAnomaly' - $ref: '#/components/schemas/AlertDefPropertiesLogsNewValue' - $ref: '#/components/schemas/AlertDefPropertiesTracingImmediate' - $ref: '#/components/schemas/AlertDefPropertiesLogsTimeRelativeThreshold' - $ref: '#/components/schemas/AlertDefPropertiesTracingThreshold' - $ref: '#/components/schemas/AlertDefPropertiesLogsUniqueCount' - $ref: '#/components/schemas/AlertDefPropertiesSloThreshold' ReplaceAlertDefResponse: title: Replace alert definition response type: object properties: alertDef: $ref: '#/components/schemas/AlertDef' description: A response that contains the updated alert definition externalDocs: url: '' AlertDefPropertiesLogsImmediate: title: Alert definition properties type: object properties: activeOn: $ref: '#/components/schemas/ActivitySchedule' deleted: type: boolean description: Whether the alert has been marked as deleted example: false description: type: string description: >- A detailed description of what the alert monitors and when it triggers example: Alert description enabled: type: boolean description: Whether the alert is currently active and monitoring example: true entityLabels: type: object additionalProperties: type: string description: Labels used to identify and categorize the alert entity groupByKeys: type: array items: type: string description: Keys used to group and aggregate alert data example: - key1 - key2 incidentsSettings: $ref: '#/components/schemas/AlertDefIncidentSettings' logsImmediate: $ref: '#/components/schemas/LogsImmediateType' name: type: string description: The name of the alert definition example: My Alert notificationGroup: $ref: '#/components/schemas/AlertDefNotificationGroup' notificationGroupExcess: type: array items: $ref: '#/components/schemas/AlertDefNotificationGroup' phantomMode: type: boolean description: Whether the alert is in phantom mode (creating incidents or not) example: false priority: $ref: '#/components/schemas/AlertDefPriority' type: $ref: '#/components/schemas/AlertDefType' additionalProperties: false description: User-configurable properties of an alert definition externalDocs: url: '' AlertDefPropertiesLogsThreshold: title: Alert definition properties type: object properties: activeOn: $ref: '#/components/schemas/ActivitySchedule' deleted: type: boolean description: Whether the alert has been marked as deleted example: false description: type: string description: >- A detailed description of what the alert monitors and when it triggers example: Alert description enabled: type: boolean description: Whether the alert is currently active and monitoring example: true entityLabels: type: object additionalProperties: type: string description: Labels used to identify and categorize the alert entity groupByKeys: type: array items: type: string description: Keys used to group and aggregate alert data example: - key1 - key2 incidentsSettings: $ref: '#/components/schemas/AlertDefIncidentSettings' logsThreshold: $ref: '#/components/schemas/LogsThresholdType' name: type: string description: The name of the alert definition example: My Alert notificationGroup: $ref: '#/components/schemas/AlertDefNotificationGroup' notificationGroupExcess: type: array items: $ref: '#/components/schemas/AlertDefNotificationGroup' phantomMode: type: boolean description: Whether the alert is in phantom mode (creating incidents or not) example: false priority: $ref: '#/components/schemas/AlertDefPriority' type: $ref: '#/components/schemas/AlertDefType' additionalProperties: false description: User-configurable properties of an alert definition externalDocs: url: '' AlertDefPropertiesLogsRatioThreshold: title: Alert definition properties type: object properties: activeOn: $ref: '#/components/schemas/ActivitySchedule' deleted: type: boolean description: Whether the alert has been marked as deleted example: false description: type: string description: >- A detailed description of what the alert monitors and when it triggers example: Alert description enabled: type: boolean description: Whether the alert is currently active and monitoring example: true entityLabels: type: object additionalProperties: type: string description: Labels used to identify and categorize the alert entity groupByKeys: type: array items: type: string description: Keys used to group and aggregate alert data example: - key1 - key2 incidentsSettings: $ref: '#/components/schemas/AlertDefIncidentSettings' logsRatioThreshold: $ref: '#/components/schemas/LogsRatioThresholdType' name: type: string description: The name of the alert definition example: My Alert notificationGroup: $ref: '#/components/schemas/AlertDefNotificationGroup' notificationGroupExcess: type: array items: $ref: '#/components/schemas/AlertDefNotificationGroup' phantomMode: type: boolean description: Whether the alert is in phantom mode (creating incidents or not) example: false priority: $ref: '#/components/schemas/AlertDefPriority' type: $ref: '#/components/schemas/AlertDefType' additionalProperties: false description: User-configurable properties of an alert definition externalDocs: url: '' AlertDefPropertiesMetricThreshold: title: Alert definition properties type: object properties: activeOn: $ref: '#/components/schemas/ActivitySchedule' deleted: type: boolean description: Whether the alert has been marked as deleted example: false description: type: string description: >- A detailed description of what the alert monitors and when it triggers example: Alert description enabled: type: boolean description: Whether the alert is currently active and monitoring example: true entityLabels: type: object additionalProperties: type: string description: Labels used to identify and categorize the alert entity groupByKeys: type: array items: type: string description: Keys used to group and aggregate alert data example: - key1 - key2 incidentsSettings: $ref: '#/components/schemas/AlertDefIncidentSettings' metricThreshold: $ref: '#/components/schemas/MetricThresholdType' name: type: string description: The name of the alert definition example: My Alert notificationGroup: $ref: '#/components/schemas/AlertDefNotificationGroup' notificationGroupExcess: type: array items: $ref: '#/components/schemas/AlertDefNotificationGroup' phantomMode: type: boolean description: Whether the alert is in phantom mode (creating incidents or not) example: false priority: $ref: '#/components/schemas/AlertDefPriority' type: $ref: '#/components/schemas/AlertDefType' additionalProperties: false description: User-configurable properties of an alert definition externalDocs: url: '' AlertDefPropertiesFlow: title: Alert definition properties type: object properties: activeOn: $ref: '#/components/schemas/ActivitySchedule' deleted: type: boolean description: Whether the alert has been marked as deleted example: false description: type: string description: >- A detailed description of what the alert monitors and when it triggers example: Alert description enabled: type: boolean description: Whether the alert is currently active and monitoring example: true entityLabels: type: object additionalProperties: type: string description: Labels used to identify and categorize the alert entity flow: $ref: '#/components/schemas/FlowType' groupByKeys: type: array items: type: string description: Keys used to group and aggregate alert data example: - key1 - key2 incidentsSettings: $ref: '#/components/schemas/AlertDefIncidentSettings' name: type: string description: The name of the alert definition example: My Alert notificationGroup: $ref: '#/components/schemas/AlertDefNotificationGroup' notificationGroupExcess: type: array items: $ref: '#/components/schemas/AlertDefNotificationGroup' phantomMode: type: boolean description: Whether the alert is in phantom mode (creating incidents or not) example: false priority: $ref: '#/components/schemas/AlertDefPriority' type: $ref: '#/components/schemas/AlertDefType' additionalProperties: false description: User-configurable properties of an alert definition externalDocs: url: '' AlertDefPropertiesLogsAnomaly: title: Alert definition properties type: object properties: activeOn: $ref: '#/components/schemas/ActivitySchedule' deleted: type: boolean description: Whether the alert has been marked as deleted example: false description: type: string description: >- A detailed description of what the alert monitors and when it triggers example: Alert description enabled: type: boolean description: Whether the alert is currently active and monitoring example: true entityLabels: type: object additionalProperties: type: string description: Labels used to identify and categorize the alert entity groupByKeys: type: array items: type: string description: Keys used to group and aggregate alert data example: - key1 - key2 incidentsSettings: $ref: '#/components/schemas/AlertDefIncidentSettings' logsAnomaly: $ref: '#/components/schemas/LogsAnomalyType' name: type: string description: The name of the alert definition example: My Alert notificationGroup: $ref: '#/components/schemas/AlertDefNotificationGroup' notificationGroupExcess: type: array items: $ref: '#/components/schemas/AlertDefNotificationGroup' phantomMode: type: boolean description: Whether the alert is in phantom mode (creating incidents or not) example: false priority: $ref: '#/components/schemas/AlertDefPriority' type: $ref: '#/components/schemas/AlertDefType' additionalProperties: false description: User-configurable properties of an alert definition externalDocs: url: '' AlertDefPropertiesMetricAnomaly: title: Alert definition properties type: object properties: activeOn: $ref: '#/components/schemas/ActivitySchedule' deleted: type: boolean description: Whether the alert has been marked as deleted example: false description: type: string description: >- A detailed description of what the alert monitors and when it triggers example: Alert description enabled: type: boolean description: Whether the alert is currently active and monitoring example: true entityLabels: type: object additionalProperties: type: string description: Labels used to identify and categorize the alert entity groupByKeys: type: array items: type: string description: Keys used to group and aggregate alert data example: - key1 - key2 incidentsSettings: $ref: '#/components/schemas/AlertDefIncidentSettings' metricAnomaly: $ref: '#/components/schemas/MetricAnomalyType' name: type: string description: The name of the alert definition example: My Alert notificationGroup: $ref: '#/components/schemas/AlertDefNotificationGroup' notificationGroupExcess: type: array items: $ref: '#/components/schemas/AlertDefNotificationGroup' phantomMode: type: boolean description: Whether the alert is in phantom mode (creating incidents or not) example: false priority: $ref: '#/components/schemas/AlertDefPriority' type: $ref: '#/components/schemas/AlertDefType' additionalProperties: false description: User-configurable properties of an alert definition externalDocs: url: '' AlertDefPropertiesLogsNewValue: title: Alert definition properties type: object properties: activeOn: $ref: '#/components/schemas/ActivitySchedule' deleted: type: boolean description: Whether the alert has been marked as deleted example: false description: type: string description: >- A detailed description of what the alert monitors and when it triggers example: Alert description enabled: type: boolean description: Whether the alert is currently active and monitoring example: true entityLabels: type: object additionalProperties: type: string description: Labels used to identify and categorize the alert entity groupByKeys: type: array items: type: string description: Keys used to group and aggregate alert data example: - key1 - key2 incidentsSettings: $ref: '#/components/schemas/AlertDefIncidentSettings' logsNewValue: $ref: '#/components/schemas/LogsNewValueType' name: type: string description: The name of the alert definition example: My Alert notificationGroup: $ref: '#/components/schemas/AlertDefNotificationGroup' notificationGroupExcess: type: array items: $ref: '#/components/schemas/AlertDefNotificationGroup' phantomMode: type: boolean description: Whether the alert is in phantom mode (creating incidents or not) example: false priority: $ref: '#/components/schemas/AlertDefPriority' type: $ref: '#/components/schemas/AlertDefType' additionalProperties: false description: User-configurable properties of an alert definition externalDocs: url: '' AlertDefPropertiesTracingImmediate: title: Alert definition properties type: object properties: activeOn: $ref: '#/components/schemas/ActivitySchedule' deleted: type: boolean description: Whether the alert has been marked as deleted example: false description: type: string description: >- A detailed description of what the alert monitors and when it triggers example: Alert description enabled: type: boolean description: Whether the alert is currently active and monitoring example: true entityLabels: type: object additionalProperties: type: string description: Labels used to identify and categorize the alert entity groupByKeys: type: array items: type: string description: Keys used to group and aggregate alert data example: - key1 - key2 incidentsSettings: $ref: '#/components/schemas/AlertDefIncidentSettings' name: type: string description: The name of the alert definition example: My Alert notificationGroup: $ref: '#/components/schemas/AlertDefNotificationGroup' notificationGroupExcess: type: array items: $ref: '#/components/schemas/AlertDefNotificationGroup' phantomMode: type: boolean description: Whether the alert is in phantom mode (creating incidents or not) example: false priority: $ref: '#/components/schemas/AlertDefPriority' tracingImmediate: $ref: '#/components/schemas/TracingImmediateType' type: $ref: '#/components/schemas/AlertDefType' additionalProperties: false description: User-configurable properties of an alert definition externalDocs: url: '' AlertDefPropertiesLogsTimeRelativeThreshold: title: Alert definition properties type: object properties: activeOn: $ref: '#/components/schemas/ActivitySchedule' deleted: type: boolean description: Whether the alert has been marked as deleted example: false description: type: string description: >- A detailed description of what the alert monitors and when it triggers example: Alert description enabled: type: boolean description: Whether the alert is currently active and monitoring example: true entityLabels: type: object additionalProperties: type: string description: Labels used to identify and categorize the alert entity groupByKeys: type: array items: type: string description: Keys used to group and aggregate alert data example: - key1 - key2 incidentsSettings: $ref: '#/components/schemas/AlertDefIncidentSettings' logsTimeRelativeThreshold: $ref: '#/components/schemas/LogsTimeRelativeThresholdType' name: type: string description: The name of the alert definition example: My Alert notificationGroup: $ref: '#/components/schemas/AlertDefNotificationGroup' notificationGroupExcess: type: array items: $ref: '#/components/schemas/AlertDefNotificationGroup' phantomMode: type: boolean description: Whether the alert is in phantom mode (creating incidents or not) example: false priority: $ref: '#/components/schemas/AlertDefPriority' type: $ref: '#/components/schemas/AlertDefType' additionalProperties: false description: User-configurable properties of an alert definition externalDocs: url: '' AlertDefPropertiesTracingThreshold: title: Alert definition properties type: object properties: activeOn: $ref: '#/components/schemas/ActivitySchedule' deleted: type: boolean description: Whether the alert has been marked as deleted example: false description: type: string description: >- A detailed description of what the alert monitors and when it triggers example: Alert description enabled: type: boolean description: Whether the alert is currently active and monitoring example: true entityLabels: type: object additionalProperties: type: string description: Labels used to identify and categorize the alert entity groupByKeys: type: array items: type: string description: Keys used to group and aggregate alert data example: - key1 - key2 incidentsSettings: $ref: '#/components/schemas/AlertDefIncidentSettings' name: type: string description: The name of the alert definition example: My Alert notificationGroup: $ref: '#/components/schemas/AlertDefNotificationGroup' notificationGroupExcess: type: array items: $ref: '#/components/schemas/AlertDefNotificationGroup' phantomMode: type: boolean description: Whether the alert is in phantom mode (creating incidents or not) example: false priority: $ref: '#/components/schemas/AlertDefPriority' tracingThreshold: $ref: '#/components/schemas/TracingThresholdType' type: $ref: '#/components/schemas/AlertDefType' additionalProperties: false description: User-configurable properties of an alert definition externalDocs: url: '' AlertDefPropertiesLogsUniqueCount: title: Alert definition properties type: object properties: activeOn: $ref: '#/components/schemas/ActivitySchedule' deleted: type: boolean description: Whether the alert has been marked as deleted example: false description: type: string description: >- A detailed description of what the alert monitors and when it triggers example: Alert description enabled: type: boolean description: Whether the alert is currently active and monitoring example: true entityLabels: type: object additionalProperties: type: string description: Labels used to identify and categorize the alert entity groupByKeys: type: array items: type: string description: Keys used to group and aggregate alert data example: - key1 - key2 incidentsSettings: $ref: '#/components/schemas/AlertDefIncidentSettings' logsUniqueCount: $ref: '#/components/schemas/LogsUniqueCountType' name: type: string description: The name of the alert definition example: My Alert notificationGroup: $ref: '#/components/schemas/AlertDefNotificationGroup' notificationGroupExcess: type: array items: $ref: '#/components/schemas/AlertDefNotificationGroup' phantomMode: type: boolean description: Whether the alert is in phantom mode (creating incidents or not) example: false priority: $ref: '#/components/schemas/AlertDefPriority' type: $ref: '#/components/schemas/AlertDefType' additionalProperties: false description: User-configurable properties of an alert definition externalDocs: url: '' AlertDefPropertiesSloThreshold: title: Alert definition properties type: object properties: activeOn: $ref: '#/components/schemas/ActivitySchedule' deleted: type: boolean description: Whether the alert has been marked as deleted example: false description: type: string description: >- A detailed description of what the alert monitors and when it triggers example: Alert description enabled: type: boolean description: Whether the alert is currently active and monitoring example: true entityLabels: type: object additionalProperties: type: string description: Labels used to identify and categorize the alert entity groupByKeys: type: array items: type: string description: Keys used to group and aggregate alert data example: - key1 - key2 incidentsSettings: $ref: '#/components/schemas/AlertDefIncidentSettings' name: type: string description: The name of the alert definition example: My Alert notificationGroup: $ref: '#/components/schemas/AlertDefNotificationGroup' notificationGroupExcess: type: array items: $ref: '#/components/schemas/AlertDefNotificationGroup' phantomMode: type: boolean description: Whether the alert is in phantom mode (creating incidents or not) example: false priority: $ref: '#/components/schemas/AlertDefPriority' sloThreshold: $ref: '#/components/schemas/SloThresholdType' type: $ref: '#/components/schemas/AlertDefType' additionalProperties: false description: User-configurable properties of an alert definition externalDocs: url: '' AlertDef: title: Alert definition type: object properties: alertDefProperties: $ref: '#/components/schemas/AlertDefProperties' alertVersionId: type: string description: The old alert ID createdTime: type: string description: The time when the alert definition was created format: date-time example: '2023-10-01T12:00:00.000Z' id: type: string description: The alert definition's persistent ID example: 123e4567-e89b-12d3-a456-426614174000 lastTriggeredTime: type: string description: The last time the alert definition was triggered format: date-time example: '2023-10-01T12:00:00.000Z' status: $ref: '#/components/schemas/AlertDefStatus' updatedTime: type: string description: The time when the alert definition was last updated format: date-time example: '2023-10-01T12:00:00.000Z' description: This data structure represents an alert definition externalDocs: description: Find out more about alerts in our documentation url: >- https://coralogix.com/docs/user-guides/alerting/introduction-to-alerts/ ActivitySchedule: title: Alert activity schedule type: object properties: dayOfWeek: type: array items: $ref: '#/components/schemas/DayOfWeek' example: - DAY_OF_WEEK_MONDAY_OR_UNSPECIFIED - DAY_OF_WEEK_TUESDAY endTime: $ref: '#/components/schemas/TimeOfDay' startTime: $ref: '#/components/schemas/TimeOfDay' description: >- Defines when an alert should be active based on days of the week and time windows externalDocs: url: '' AlertDefIncidentSettings: title: Alert definition incident settings type: object properties: minutes: type: integer description: The time in minutes before the alert can be retriggered format: int64 example: 30 notifyOn: $ref: '#/components/schemas/NotifyOn' externalDocs: url: '' LogsImmediateType: title: Logs immediate alert type type: object properties: logsFilter: $ref: '#/components/schemas/v3.LogsFilter' notificationPayloadFilter: type: array items: type: string example: - obj.field description: >- Configuration for immediate alerts triggered on log entries matching specific filters. externalDocs: description: Learn more about logs immediate alerts in our documentation url: >- https://coralogix.com/docs/user-guides/alerting/create-an-alert/logs/immediate-notifications/ AlertDefNotificationGroup: title: Alert definition notification group type: object properties: destinations: type: array items: $ref: '#/components/schemas/NotificationDestination' groupByKeys: type: array items: type: string description: The keys to group the alerts by example: - key1 - key2 router: $ref: '#/components/schemas/NotificationRouter' webhooks: type: array items: $ref: '#/components/schemas/AlertDefWebhooksSettings' externalDocs: url: '' AlertDefPriority: enum: - ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED - ALERT_DEF_PRIORITY_P4 - ALERT_DEF_PRIORITY_P3 - ALERT_DEF_PRIORITY_P2 - ALERT_DEF_PRIORITY_P1 type: string AlertDefType: enum: - 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 type: string LogsThresholdType: title: Log-based threshold alert type type: object properties: evaluationDelayMs: type: integer description: The delay in milliseconds before evaluating the alert condition format: int32 example: 60000 logsFilter: $ref: '#/components/schemas/v3.LogsFilter' notificationPayloadFilter: type: array items: type: string description: >- The filter to specify which fields to include in the notification payload example: - obj.field rules: type: array items: $ref: '#/components/schemas/LogsThresholdRule' undetectedValuesManagement: $ref: '#/components/schemas/v3.UndetectedValuesManagement' description: >- Configuration for alerts triggered when log counts exceed or fall below specified thresholds externalDocs: description: Learn more about log-based threshold alerts in our documentation url: >- https://coralogix.com/docs/user-guides/alerting/create-an-alert/logs/threshold-alerts/ LogsRatioThresholdType: title: Log-based ratio threshold alert type type: object properties: denominator: $ref: '#/components/schemas/v3.LogsFilter' denominatorAlias: type: string description: The alias for the denominator filter, used for display purposes example: denominator_alias evaluationDelayMs: type: integer description: The delay in milliseconds before evaluating the alert condition format: int32 example: 60000 groupByFor: $ref: '#/components/schemas/LogsRatioGroupByFor' ignoreInfinity: type: boolean description: The configuration for ignoring infinity values in the ratio example: true notificationPayloadFilter: type: array items: type: string example: - obj.field numerator: $ref: '#/components/schemas/v3.LogsFilter' numeratorAlias: type: string description: The alias for the numerator filter, used for display purposes example: numerator_alias rules: type: array items: $ref: '#/components/schemas/LogsRatioRules' undetectedValuesManagement: $ref: '#/components/schemas/v3.UndetectedValuesManagement' description: Configuration for alerts based on the ratio between two log queries externalDocs: description: Learn more about logs ratio alerts in our documentation url: >- https://coralogix.com/docs/user-guides/alerting/create-an-alert/logs/ratio-alerts/ MetricThresholdType: title: Metric-based threshold alert type type: object properties: evaluationDelayMs: type: integer description: The delay in milliseconds before evaluating the alert condition format: int32 example: 60000 metricFilter: $ref: '#/components/schemas/MetricFilter' missingValues: $ref: '#/components/schemas/MetricMissingValues' rules: type: array items: $ref: '#/components/schemas/MetricThresholdRule' undetectedValuesManagement: $ref: '#/components/schemas/v3.UndetectedValuesManagement' description: Configuration for alerts based on metric threshold violations externalDocs: description: Learn more about metric-based threshold alerts in our documentation url: >- https://coralogix.com/docs/user-guides/alerting/create-an-alert/metrics/threshold-alerts/ FlowType: title: Flow alert type type: object properties: enforceSuppression: type: boolean stages: type: array items: $ref: '#/components/schemas/FlowStages' description: Configuration for flow-based alerts with multiple stages externalDocs: description: Learn more about flow alerts in our documentation url: >- https://coralogix.com/docs/user-guides/alerting/create-an-alert/flow-alerts/ LogsAnomalyType: title: Log-based anomaly alert type type: object properties: anomalyAlertSettings: $ref: '#/components/schemas/AnomalyAlertSettings' evaluationDelayMs: type: integer description: The delay in milliseconds before evaluating the alert condition format: int32 example: 60000 logsFilter: $ref: '#/components/schemas/v3.LogsFilter' notificationPayloadFilter: type: array items: type: string description: >- The filter to specify which fields to include in the notification payload example: - obj.field rules: type: array items: $ref: '#/components/schemas/LogsAnomalyRule' description: Configuration for alerts triggered by anomalous log patterns externalDocs: description: Learn more about logs anomaly alerts in our documentation url: >- https://coralogix.com/docs/user-guides/alerting/create-an-alert/logs/anomaly-detection-alerts/ MetricAnomalyType: title: Metric-based anomaly alert type type: object properties: anomalyAlertSettings: $ref: '#/components/schemas/AnomalyAlertSettings' evaluationDelayMs: type: integer description: The delay in milliseconds before evaluating the alert condition format: int32 example: 60000 metricFilter: $ref: '#/components/schemas/MetricFilter' rules: type: array items: $ref: '#/components/schemas/MetricAnomalyRule' description: Configuration for alerts triggered by anomalous metric patterns externalDocs: description: Learn more about metric-based anomaly alerts in our documentation url: >- https://coralogix.com/docs/user-guides/alerting/create-an-alert/metrics/anomaly-detection-alerts/ LogsNewValueType: title: Log-based new value alert type type: object properties: logsFilter: $ref: '#/components/schemas/v3.LogsFilter' notificationPayloadFilter: type: array items: type: string description: >- The filter to specify which fields to include in the notification payload. example: - obj.field rules: type: array items: $ref: '#/components/schemas/LogsNewValueRule' description: Configuration for alerts triggered by new values appearing in logs externalDocs: url: '' TracingImmediateType: title: Trace-based immediate alert type type: object properties: notificationPayloadFilter: type: array items: type: string description: Notification payload field filter example: - obj.field tracingFilter: $ref: '#/components/schemas/TracingFilter' description: Configuration for immediate alerts triggered on trace entries externalDocs: description: Learn more about trace-based alerts in our documentation. url: >- https://coralogix.com/docs/user-guides/alerting/create-an-alert/traces/tracing-alerts/ LogsTimeRelativeThresholdType: title: Log-based time-relative threshold alert type type: object properties: evaluationDelayMs: type: integer description: The delay in milliseconds before evaluating the alert condition format: int32 example: 60000 ignoreInfinity: type: boolean description: Ignore infinity values in the alert example: true logsFilter: $ref: '#/components/schemas/v3.LogsFilter' notificationPayloadFilter: type: array items: type: string example: - obj.field rules: type: array items: $ref: '#/components/schemas/LogsTimeRelativeRule' undetectedValuesManagement: $ref: '#/components/schemas/v3.UndetectedValuesManagement' description: >- Configuration for alerts that are triggered when a fixed ratio reaches a set threshold compared to a past time frame. externalDocs: description: Learn more about log-based, time-relative alerts in our documentation url: >- https://coralogix.com/docs/user-guides/alerting/create-an-alert/logs/time-relative-alerts/ TracingThresholdType: title: Trace-based threshold alert type type: object properties: notificationPayloadFilter: type: array items: type: string description: Notification payload field filter example: - obj.field rules: type: array items: $ref: '#/components/schemas/TracingThresholdRule' tracingFilter: $ref: '#/components/schemas/TracingFilter' description: Configuration for alerts based on trace count thresholds externalDocs: description: Learn more about trace-based alerts in our documentation url: >- https://coralogix.com/docs/user-guides/alerting/create-an-alert/traces/tracing-alerts/ LogsUniqueCountType: title: Log-based unique count alert type type: object properties: logsFilter: $ref: '#/components/schemas/v3.LogsFilter' maxUniqueCountPerGroupByKey: type: string description: The maximum unique count per group by key format: int64 example: '100' notificationPayloadFilter: type: array items: type: string description: >- The filter to specify which fields to include in the notification payload example: - obj.field rules: type: array items: $ref: '#/components/schemas/LogsUniqueCountRule' uniqueCountKeypath: type: string description: The keypath in the logs to be used for unique count example: obj.field description: Configuration for alerts based on unique value counts in logs externalDocs: description: Learn more about log-based, unique count alerts in our documentation url: >- https://coralogix.com/docs/user-guides/alerting/create-an-alert/logs/unique-count-alerts/ SloThresholdType: oneOf: - $ref: '#/components/schemas/SloThresholdTypeErrorBudget' - $ref: '#/components/schemas/SloThresholdTypeBurnRate' AlertDefStatus: enum: - ALERT_DEF_STATUS_UNSPECIFIED - ALERT_DEF_STATUS_ALERTING - ALERT_DEF_STATUS_OK - ALERT_DEF_STATUS_NO_DATA type: string DayOfWeek: enum: - 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 type: string TimeOfDay: title: Time of day type: object properties: hours: type: integer format: int32 example: 14 minutes: type: integer format: int32 example: 30 description: Represents a specific time in a 24-hour format externalDocs: url: '' NotifyOn: enum: - NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED - NOTIFY_ON_TRIGGERED_AND_RESOLVED type: string v3.LogsFilter: title: Log filter type: object properties: simpleFilter: $ref: '#/components/schemas/LogsSimpleFilter' description: Filter configuration for log-based alerts externalDocs: url: '' NotificationDestination: title: Notification destination configuration type: object properties: connectorId: type: string description: The connector ID used to send notifications example: connector_id_example notifyOn: $ref: '#/components/schemas/NotifyOn' presetId: type: string description: Optional preset ID for the notification destination example: preset_id_example resolvedRouteOverrides: $ref: '#/components/schemas/NotificationRouting' triggeredRoutingOverrides: $ref: '#/components/schemas/NotificationRouting' description: Configuration for where and how alert notifications should be sent externalDocs: description: Learn more about alert notification destinations in our documentation url: >- https://coralogix.com/docs/user-guides/alerting/configure-notifications/destinations/ NotificationRouter: title: Notification router type: object properties: id: type: string description: The ID of the notification router example: 123e4567-e89b-12d3-a456-426614174000 notifyOn: $ref: '#/components/schemas/NotifyOn' description: Configuration for routing notifications externalDocs: url: '' AlertDefWebhooksSettings: title: Alert definition webhook settings type: object properties: integration: $ref: '#/components/schemas/v3.IntegrationType' minutes: type: integer description: The time in minutes before the alert can be retriggered format: int64 example: 15 notifyOn: $ref: '#/components/schemas/NotifyOn' description: Configuration for webhook notifications for an alert externalDocs: url: '' LogsThresholdRule: title: Logs Threshold Rule type: object properties: condition: $ref: '#/components/schemas/LogsThresholdCondition' override: $ref: '#/components/schemas/AlertDefOverride' description: >- LogsThresholdRule is a message that defines a rule for log-based threshold alerts. externalDocs: url: '' v3.UndetectedValuesManagement: title: Undetected value management type: object properties: autoRetireTimeframe: $ref: '#/components/schemas/v3.AutoRetireTimeframe' triggerUndetectedValues: type: boolean description: Should trigger the alert when undetected values are detected example: true description: Configuration for handling undetected values in alerts externalDocs: url: '' LogsRatioGroupByFor: enum: - LOGS_RATIO_GROUP_BY_FOR_BOTH_OR_UNSPECIFIED - LOGS_RATIO_GROUP_BY_FOR_NUMERATOR_ONLY - LOGS_RATIO_GROUP_BY_FOR_DENUMERATOR_ONLY type: string LogsRatioRules: title: Log-based ratio rules type: object properties: condition: $ref: '#/components/schemas/LogsRatioCondition' override: $ref: '#/components/schemas/AlertDefOverride' description: Defines the rules for log-based ratio alerts externalDocs: url: '' MetricFilter: title: Metric filter configuration in alerts type: object properties: promql: type: string description: A PromQL filter for metrics example: avg_over_time(metric_name[5m]) > 10 externalDocs: url: '' MetricMissingValues: oneOf: - $ref: '#/components/schemas/MetricMissingValuesReplaceWithZero' - $ref: '#/components/schemas/MetricMissingValuesMinNonNullValuesPct' MetricThresholdRule: title: Metric Threshold Rule type: object properties: condition: $ref: '#/components/schemas/MetricThresholdCondition' override: $ref: '#/components/schemas/AlertDefOverride' description: Defines a rule for metric-based threshold alerts externalDocs: url: '' FlowStages: title: Flow stages type: object properties: flowStagesGroups: $ref: '#/components/schemas/FlowStagesGroups' timeframeMs: type: string format: int64 timeframeType: $ref: '#/components/schemas/TimeframeType' description: Defines stages in a flow alert externalDocs: url: '' AnomalyAlertSettings: title: Anomaly alert settings type: object properties: percentageOfDeviation: type: number description: >- The percentage of deviation from the baseline for triggering the alert. format: float description: Common settings for anomaly-based alerts. externalDocs: url: '' LogsAnomalyRule: title: Log-based anomaly rule type: object properties: condition: $ref: '#/components/schemas/LogsAnomalyCondition' description: Defines a rule for detecting log anomalies externalDocs: url: '' MetricAnomalyRule: title: Metric-based anomaly rule type: object properties: condition: $ref: '#/components/schemas/MetricAnomalyCondition' description: A rule for metric-based anomaly detection alerts externalDocs: url: '' LogsNewValueRule: title: Log-based new value rule type: object properties: condition: $ref: '#/components/schemas/LogsNewValueCondition' description: Defines the condition for detecting new values in logs externalDocs: url: '' TracingFilter: title: Tracing filter type: object properties: simpleFilter: $ref: '#/components/schemas/TracingSimpleFilter' description: Filter configuration for tracing-based alerts externalDocs: url: '' LogsTimeRelativeRule: title: Logs Time Relative Rule type: object properties: condition: $ref: '#/components/schemas/LogsTimeRelativeCondition' override: $ref: '#/components/schemas/AlertDefOverride' description: >- LogsTimeRelativeRule is a message that defines a rule for log-based time-relative alerts externalDocs: url: '' TracingThresholdRule: title: Trace Threshold Rule type: object properties: condition: $ref: '#/components/schemas/TracingThresholdCondition' description: A rule for trace-based threshold alerts externalDocs: url: '' LogsUniqueCountRule: title: Log-based unique count rule type: object properties: condition: $ref: '#/components/schemas/LogsUniqueCountCondition' description: Defines the rule for detecting unique counts in logs externalDocs: url: '' SloThresholdTypeErrorBudget: title: SLO Threshold Type type: object properties: errorBudget: $ref: '#/components/schemas/ErrorBudgetThreshold' sloDefinition: $ref: '#/components/schemas/v3.SloDefinition' additionalProperties: false description: SLO threshold type definition externalDocs: url: '' SloThresholdTypeBurnRate: title: SLO Threshold Type type: object properties: burnRate: $ref: '#/components/schemas/BurnRateThreshold' sloDefinition: $ref: '#/components/schemas/v3.SloDefinition' additionalProperties: false description: SLO threshold type definition externalDocs: url: '' LogsSimpleFilter: title: Simple log filter type: object properties: labelFilters: $ref: '#/components/schemas/LabelFilters' luceneQuery: type: string description: Basic filter configuration using a Lucene query and label filters externalDocs: url: '' NotificationRouting: title: Notification routing type: object properties: configOverrides: $ref: '#/components/schemas/v3.SourceOverrides' externalDocs: url: '' v3.IntegrationType: oneOf: - $ref: '#/components/schemas/V3IntegrationTypeIntegrationId' - $ref: '#/components/schemas/V3IntegrationTypeRecipients' LogsThresholdCondition: title: Logs Threshold Condition type: object properties: conditionType: $ref: '#/components/schemas/LogsThresholdConditionType' threshold: type: number description: The threshold value for the alert condition format: double example: 100 timeWindow: $ref: '#/components/schemas/LogsTimeWindow' description: >- LogsThresholdCondition is a message that defines the condition for log-based threshold alerts. externalDocs: url: '' AlertDefOverride: title: Alert definition priority update type: object properties: priority: $ref: '#/components/schemas/AlertDefPriority' externalDocs: url: '' v3.AutoRetireTimeframe: enum: - AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED - AUTO_RETIRE_TIMEFRAME_MINUTES_5 - AUTO_RETIRE_TIMEFRAME_MINUTES_10 - AUTO_RETIRE_TIMEFRAME_HOUR_1 - AUTO_RETIRE_TIMEFRAME_HOURS_2 - AUTO_RETIRE_TIMEFRAME_HOURS_6 - AUTO_RETIRE_TIMEFRAME_HOURS_12 - AUTO_RETIRE_TIMEFRAME_HOURS_24 type: string LogsRatioCondition: title: Log-based ratio condition type: object properties: conditionType: $ref: '#/components/schemas/LogsRatioConditionType' threshold: type: number description: The threshold value for the alert condition format: double example: 10 timeWindow: $ref: '#/components/schemas/LogsRatioTimeWindow' description: Defines conditions for ratio-based alerts externalDocs: url: '' MetricMissingValuesReplaceWithZero: title: Metric Missing Values Configuration type: object properties: replaceWithZero: type: boolean description: If set to true, missing values will be replaced with zero example: true additionalProperties: false description: Configuration for handling missing values in metric threshold alerts. externalDocs: url: '' MetricMissingValuesMinNonNullValuesPct: title: Metric Missing Values Configuration type: object properties: minNonNullValuesPct: type: integer description: >- If set, specifies the minimum percentage of non-null values required for the alert to be triggered format: int64 example: 80 additionalProperties: false description: Configuration for handling missing values in metric threshold alerts. externalDocs: url: '' MetricThresholdCondition: title: Metric Threshold Condition type: object properties: conditionType: $ref: '#/components/schemas/MetricThresholdConditionType' forOverPct: type: integer description: >- The percentage of values that must exceed the threshold to trigger the alert format: int64 example: 80 ofTheLast: $ref: '#/components/schemas/MetricTimeWindow' threshold: type: number description: The threshold value for the alert condition format: double example: 100 description: Defines conditions for metric threshold alerts externalDocs: url: '' FlowStagesGroups: title: Flow stage groups type: object properties: groups: type: array items: $ref: '#/components/schemas/FlowStagesGroup' description: Groups of stages in a flow alert externalDocs: url: '' TimeframeType: enum: - TIMEFRAME_TYPE_UNSPECIFIED - TIMEFRAME_TYPE_UP_TO type: string LogsAnomalyCondition: title: Log-based anomaly condition type: object properties: conditionType: $ref: '#/components/schemas/LogsAnomalyConditionType' minimumThreshold: type: number description: The threshold value for the alert condition format: double example: 10 timeWindow: $ref: '#/components/schemas/LogsTimeWindow' description: Defines conditions for detecting log anomalies externalDocs: url: '' MetricAnomalyCondition: title: Metric-based anomaly condition type: object properties: conditionType: $ref: '#/components/schemas/MetricAnomalyConditionType' forOverPct: type: integer description: >- The percentage of the metric that must exceed the threshold to trigger the alert format: int64 example: 20 minNonNullValuesPct: type: integer description: The percentage of non-null values required to trigger the alert format: int64 example: 10 ofTheLast: $ref: '#/components/schemas/MetricTimeWindow' threshold: type: number description: The threshold value for the alert condition format: double example: 10 externalDocs: url: '' LogsNewValueCondition: title: Log-based new value condition type: object properties: keypathToTrack: type: string description: The keypath to track for new values example: metadata.field timeWindow: $ref: '#/components/schemas/LogsNewValueTimeWindow' description: Defines conditions for detecting new values in logs externalDocs: url: '' TracingSimpleFilter: title: Simple tracing filter type: object properties: latencyThresholdMs: type: string description: The latency threshold to filter traces in milliseconds format: uint64 example: '1000' tracingLabelFilters: $ref: '#/components/schemas/TracingLabelFilters' description: Basic filter configuration using a latency threshold and label filters externalDocs: url: '' LogsTimeRelativeCondition: title: Log-based time-relative condition type: object properties: comparedTo: $ref: '#/components/schemas/LogsTimeRelativeComparedTo' conditionType: $ref: '#/components/schemas/LogsTimeRelativeConditionType' threshold: type: number description: The threshold value for the alert condition. format: double description: Defines conditions for time-relative comparison alerts externalDocs: url: '' TracingThresholdCondition: title: Trace-based alert threshold condition type: object properties: conditionType: $ref: '#/components/schemas/TracingThresholdConditionType' spanAmount: type: number description: The threshold value for the alert condition format: double example: 100 timeWindow: $ref: '#/components/schemas/TracingTimeWindow' externalDocs: url: '' LogsUniqueCountCondition: title: Logs unique count condition type: object properties: maxUniqueCount: type: string description: The maximum unique count format: int64 example: '100' timeWindow: $ref: '#/components/schemas/LogsUniqueValueTimeWindow' description: Defines conditions for unique count alerts externalDocs: url: '' ErrorBudgetThreshold: title: Error Budget Threshold type: object properties: rules: type: array items: $ref: '#/components/schemas/SloThresholdRule' description: Error budget threshold definition externalDocs: url: '' v3.SloDefinition: title: SLO Definition type: object properties: sloId: type: string description: The SLO ID example: 123e4567-e89b-12d3-a456-426614174000 description: Configuration for SLO definition externalDocs: url: '' BurnRateThreshold: oneOf: - $ref: '#/components/schemas/BurnRateThresholdDual' - $ref: '#/components/schemas/BurnRateThresholdSingle' LabelFilters: title: Label filters type: object properties: applicationName: type: array items: $ref: '#/components/schemas/LabelFilterType' severities: type: array items: $ref: '#/components/schemas/LogSeverity' subsystemName: type: array items: $ref: '#/components/schemas/LabelFilterType' description: Filters for application name, subsystem name, and log severities externalDocs: url: '' v3.SourceOverrides: title: Source overrides type: object properties: connectorConfigFields: type: array items: $ref: '#/components/schemas/v3.ConnectorConfigField' messageConfigFields: type: array items: $ref: '#/components/schemas/v3.MessageConfigField' payloadType: type: string description: the payload type for the notification example: >- slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default externalDocs: url: '' V3IntegrationTypeIntegrationId: title: Integration type type: object properties: integrationId: type: integer description: The integration ID for the notification format: int64 example: 123 additionalProperties: false description: Defines the type of integration to use for notifications externalDocs: url: '' V3IntegrationTypeRecipients: title: Integration type type: object properties: recipients: $ref: '#/components/schemas/Recipients' additionalProperties: false description: Defines the type of integration to use for notifications externalDocs: url: '' LogsThresholdConditionType: enum: - LOGS_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED - LOGS_THRESHOLD_CONDITION_TYPE_LESS_THAN type: string LogsTimeWindow: title: Log-based alert time window type: object properties: logsTimeWindowSpecificValue: $ref: '#/components/schemas/LogsTimeWindowValue' description: Time window configuration for log-based alerts externalDocs: url: '' LogsRatioConditionType: enum: - LOGS_RATIO_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED - LOGS_RATIO_CONDITION_TYPE_LESS_THAN type: string LogsRatioTimeWindow: title: Logs ratio time window type: object properties: logsRatioTimeWindowSpecificValue: $ref: '#/components/schemas/LogsRatioTimeWindowValue' description: Time window configuration for ratio alerts externalDocs: description: Learn more about log-based ratio alerts in our documentation url: >- https://coralogix.com/docs/user-guides/alerting/create-an-alert/logs/ratio-alerts/ MetricThresholdConditionType: enum: - METRIC_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED - METRIC_THRESHOLD_CONDITION_TYPE_LESS_THAN - METRIC_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_EQUALS - METRIC_THRESHOLD_CONDITION_TYPE_LESS_THAN_OR_EQUALS type: string MetricTimeWindow: oneOf: - $ref: '#/components/schemas/MetricTimeWindowMetricTimeWindowSpecificValue' - $ref: '#/components/schemas/MetricTimeWindowMetricTimeWindowDynamicDuration' FlowStagesGroup: title: Flow stage group type: object properties: alertDefs: type: array items: $ref: '#/components/schemas/FlowStagesGroupsAlertDefs' alertsOp: $ref: '#/components/schemas/AlertsOp' nextOp: $ref: '#/components/schemas/NextOp' description: Defines a group of stages in a flow alert externalDocs: url: '' LogsAnomalyConditionType: enum: - LOGS_ANOMALY_CONDITION_TYPE_MORE_THAN_USUAL_OR_UNSPECIFIED type: string MetricAnomalyConditionType: enum: - METRIC_ANOMALY_CONDITION_TYPE_MORE_THAN_USUAL_OR_UNSPECIFIED - METRIC_ANOMALY_CONDITION_TYPE_LESS_THAN_USUAL type: string LogsNewValueTimeWindow: title: Log-based new value alert time window type: object properties: logsNewValueTimeWindowSpecificValue: $ref: '#/components/schemas/LogsNewValueTimeWindowValue' description: Time window configuration for log-based new value alerts externalDocs: url: '' TracingLabelFilters: title: Tracing label filters type: object properties: applicationName: type: array items: $ref: '#/components/schemas/TracingFilterType' operationName: type: array items: $ref: '#/components/schemas/TracingFilterType' serviceName: type: array items: $ref: '#/components/schemas/TracingFilterType' spanFields: type: array items: $ref: '#/components/schemas/TracingSpanFieldsFilterType' subsystemName: type: array items: $ref: '#/components/schemas/TracingFilterType' description: >- Filters for application name, subsystem name, service name, operation name and span fields externalDocs: url: '' LogsTimeRelativeComparedTo: enum: - LOGS_TIME_RELATIVE_COMPARED_TO_PREVIOUS_HOUR_OR_UNSPECIFIED - LOGS_TIME_RELATIVE_COMPARED_TO_SAME_HOUR_YESTERDAY - LOGS_TIME_RELATIVE_COMPARED_TO_SAME_HOUR_LAST_WEEK - LOGS_TIME_RELATIVE_COMPARED_TO_YESTERDAY - LOGS_TIME_RELATIVE_COMPARED_TO_SAME_DAY_LAST_WEEK - LOGS_TIME_RELATIVE_COMPARED_TO_SAME_DAY_LAST_MONTH type: string LogsTimeRelativeConditionType: enum: - LOGS_TIME_RELATIVE_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED - LOGS_TIME_RELATIVE_CONDITION_TYPE_LESS_THAN type: string TracingThresholdConditionType: enum: - TRACING_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED type: string TracingTimeWindow: title: Tracing time window type: object properties: tracingTimeWindowValue: $ref: '#/components/schemas/TracingTimeWindowValue' externalDocs: url: '' LogsUniqueValueTimeWindow: title: Log-based unique value alert time window type: object properties: logsUniqueValueTimeWindowSpecificValue: $ref: '#/components/schemas/LogsUniqueValueTimeWindowValue' description: Time window configuration for log-based unique value alerts externalDocs: url: '' SloThresholdRule: title: SLO Threshold Rule type: object properties: condition: $ref: '#/components/schemas/SloThresholdCondition' override: $ref: '#/components/schemas/AlertDefOverride' description: SLO threshold rule definition externalDocs: url: '' BurnRateThresholdDual: title: Burn Rate Threshold type: object properties: dual: $ref: '#/components/schemas/BurnRateTypeDual' rules: type: array items: $ref: '#/components/schemas/SloThresholdRule' additionalProperties: false description: Burn rate threshold definition externalDocs: url: '' BurnRateThresholdSingle: title: Burn Rate Threshold type: object properties: rules: type: array items: $ref: '#/components/schemas/SloThresholdRule' single: $ref: '#/components/schemas/BurnRateTypeSingle' additionalProperties: false description: Burn rate threshold definition externalDocs: url: '' LabelFilterType: title: Label filter type type: object properties: operation: $ref: '#/components/schemas/LogFilterOperationType' value: type: string description: The value of the label to filter by example: my-app description: Label filter type for log entries externalDocs: url: '' LogSeverity: enum: - LOG_SEVERITY_VERBOSE_UNSPECIFIED - LOG_SEVERITY_DEBUG - LOG_SEVERITY_INFO - LOG_SEVERITY_WARNING - LOG_SEVERITY_ERROR - LOG_SEVERITY_CRITICAL type: string v3.ConnectorConfigField: title: Connector config field type: object properties: fieldName: type: string description: The name of the configuration field example: description template: type: string description: The template for the configuration field example: template_example externalDocs: url: '' v3.MessageConfigField: title: Message config field type: object properties: fieldName: type: string description: The name of the configuration field example: description template: type: string description: The template for the configuration field example: template_example description: Configuration field for a notification message externalDocs: url: '' Recipients: title: Recipients type: object properties: emails: type: array items: type: string description: The list of email recipients for alert notifications example: - mail@gmail.com description: List of email recipients for alert notifications externalDocs: url: '' LogsTimeWindowValue: enum: - LOGS_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED - LOGS_TIME_WINDOW_VALUE_MINUTES_10 - LOGS_TIME_WINDOW_VALUE_MINUTES_20 - LOGS_TIME_WINDOW_VALUE_MINUTES_15 - LOGS_TIME_WINDOW_VALUE_MINUTES_30 - LOGS_TIME_WINDOW_VALUE_HOUR_1 - LOGS_TIME_WINDOW_VALUE_HOURS_2 - LOGS_TIME_WINDOW_VALUE_HOURS_4 - LOGS_TIME_WINDOW_VALUE_HOURS_6 - LOGS_TIME_WINDOW_VALUE_HOURS_12 - LOGS_TIME_WINDOW_VALUE_HOURS_24 - LOGS_TIME_WINDOW_VALUE_HOURS_36 type: string LogsRatioTimeWindowValue: enum: - LOGS_RATIO_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED - LOGS_RATIO_TIME_WINDOW_VALUE_MINUTES_10 - LOGS_RATIO_TIME_WINDOW_VALUE_MINUTES_15 - LOGS_RATIO_TIME_WINDOW_VALUE_MINUTES_30 - LOGS_RATIO_TIME_WINDOW_VALUE_HOUR_1 - LOGS_RATIO_TIME_WINDOW_VALUE_HOURS_2 - LOGS_RATIO_TIME_WINDOW_VALUE_HOURS_4 - LOGS_RATIO_TIME_WINDOW_VALUE_HOURS_6 - LOGS_RATIO_TIME_WINDOW_VALUE_HOURS_12 - LOGS_RATIO_TIME_WINDOW_VALUE_HOURS_24 - LOGS_RATIO_TIME_WINDOW_VALUE_HOURS_36 type: string MetricTimeWindowMetricTimeWindowSpecificValue: title: Metric time window type: object properties: metricTimeWindowSpecificValue: $ref: '#/components/schemas/MetricTimeWindowValue' additionalProperties: false externalDocs: url: '' MetricTimeWindowMetricTimeWindowDynamicDuration: title: Metric time window type: object properties: metricTimeWindowDynamicDuration: type: string description: The time window as a dynamic value example: 1h30m additionalProperties: false externalDocs: url: '' FlowStagesGroupsAlertDefs: title: Flow stage group alert definitions type: object properties: id: type: string description: The alert definition ID example: 123e4567-e89b-12d3-a456-426614174000 not: type: boolean description: Whether to negate the alert definition or not. example: true description: Alert definitions for a flow stage group externalDocs: url: '' AlertsOp: enum: - ALERTS_OP_AND_OR_UNSPECIFIED - ALERTS_OP_OR type: string NextOp: enum: - NEXT_OP_AND_OR_UNSPECIFIED - NEXT_OP_OR type: string LogsNewValueTimeWindowValue: enum: - LOGS_NEW_VALUE_TIME_WINDOW_VALUE_HOURS_12_OR_UNSPECIFIED - LOGS_NEW_VALUE_TIME_WINDOW_VALUE_HOURS_24 - LOGS_NEW_VALUE_TIME_WINDOW_VALUE_HOURS_48 - LOGS_NEW_VALUE_TIME_WINDOW_VALUE_HOURS_72 - LOGS_NEW_VALUE_TIME_WINDOW_VALUE_WEEK_1 - LOGS_NEW_VALUE_TIME_WINDOW_VALUE_MONTH_1 - LOGS_NEW_VALUE_TIME_WINDOW_VALUE_MONTHS_2 - LOGS_NEW_VALUE_TIME_WINDOW_VALUE_MONTHS_3 type: string TracingFilterType: title: Tracing filter type type: object properties: operation: $ref: '#/components/schemas/TracingFilterOperationType' values: type: array items: type: string description: The values of the label to filter by example: - value1 - value2 description: Filter type for trace entries externalDocs: url: '' TracingSpanFieldsFilterType: title: Tracing span fields filter type type: object properties: filterType: $ref: '#/components/schemas/TracingFilterType' key: type: string description: The key of the span field to filter by example: span.field.key description: A filter for span fields in trace entries externalDocs: url: '' TracingTimeWindowValue: enum: - TRACING_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED - TRACING_TIME_WINDOW_VALUE_MINUTES_10 - TRACING_TIME_WINDOW_VALUE_MINUTES_15 - TRACING_TIME_WINDOW_VALUE_MINUTES_20 - TRACING_TIME_WINDOW_VALUE_MINUTES_30 - TRACING_TIME_WINDOW_VALUE_HOUR_1 - TRACING_TIME_WINDOW_VALUE_HOURS_2 - TRACING_TIME_WINDOW_VALUE_HOURS_4 - TRACING_TIME_WINDOW_VALUE_HOURS_6 - TRACING_TIME_WINDOW_VALUE_HOURS_12 - TRACING_TIME_WINDOW_VALUE_HOURS_24 - TRACING_TIME_WINDOW_VALUE_HOURS_36 type: string LogsUniqueValueTimeWindowValue: enum: - LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_MINUTE_1_OR_UNSPECIFIED - LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_MINUTES_5 - LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_MINUTES_10 - LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_MINUTES_15 - LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_MINUTES_20 - LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_MINUTES_30 - LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_HOURS_1 - LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_HOURS_2 - LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_HOURS_4 - LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_HOURS_6 - LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_HOURS_12 - LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_HOURS_24 - LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_HOURS_36 type: string SloThresholdCondition: title: SLO Threshold Condition type: object properties: threshold: type: number format: double description: Condition for the SLO threshold rule externalDocs: url: '' BurnRateTypeDual: title: Burn Rate Type Dual type: object properties: timeDuration: $ref: '#/components/schemas/TimeDuration' description: Burn rate type dual definition externalDocs: url: '' BurnRateTypeSingle: title: Burn Rate Type Single type: object properties: timeDuration: $ref: '#/components/schemas/TimeDuration' description: Burn rate type single definition externalDocs: url: '' LogFilterOperationType: enum: - LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED - LOG_FILTER_OPERATION_TYPE_INCLUDES - LOG_FILTER_OPERATION_TYPE_ENDS_WITH - LOG_FILTER_OPERATION_TYPE_STARTS_WITH type: string MetricTimeWindowValue: enum: - METRIC_TIME_WINDOW_VALUE_MINUTES_1_OR_UNSPECIFIED - METRIC_TIME_WINDOW_VALUE_MINUTES_5 - METRIC_TIME_WINDOW_VALUE_MINUTES_10 - METRIC_TIME_WINDOW_VALUE_MINUTES_15 - METRIC_TIME_WINDOW_VALUE_MINUTES_20 - METRIC_TIME_WINDOW_VALUE_MINUTES_30 - METRIC_TIME_WINDOW_VALUE_HOUR_1 - METRIC_TIME_WINDOW_VALUE_HOURS_2 - METRIC_TIME_WINDOW_VALUE_HOURS_4 - METRIC_TIME_WINDOW_VALUE_HOURS_6 - METRIC_TIME_WINDOW_VALUE_HOURS_12 - METRIC_TIME_WINDOW_VALUE_HOURS_24 - METRIC_TIME_WINDOW_VALUE_HOURS_36 type: string TracingFilterOperationType: enum: - 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 type: string TimeDuration: title: Time duration type: object properties: duration: type: string description: The duration value format: uint64 example: '60' unit: $ref: '#/components/schemas/DurationUnit' description: Configuration for time duration externalDocs: url: '' DurationUnit: enum: - DURATION_UNIT_UNSPECIFIED - DURATION_UNIT_HOURS type: string securitySchemes: apiKeyAuth: type: apiKey in: header name: Authorization description: API key authentication ````