Our next-gen architecture is built to help you make sense of your ever-growing data. Watch a 4-min demo video!

Back to All Docs

Alert Suppression Rules API

Last Updated: May. 12, 2024

Overview

This document outlines the Alert Suppression Rules API. Alert Suppression Rules allow you to mute alerts according to your specific parameters automatically. You can set what to suppress (what group by keys), when to suppress (specific times and dates, recurring times and dates, one-time suppressions), and which alerts to suppress during those times.

Prerequisites

Before you begin, please make sure you have the following:

Authentication

Coralogix API uses API keys to authenticate requests. You can view and manage your API keys from the Data Flow tab in Coralogix. You need to use this API key in the Authorization request header to successfully connect.

Example:

grpcurl -H "Authorization: Bearer API_KEY_HERE"

Then, use one of our designated Management endpoints to structure your header.

-d @ ng-api-grpc.coralogix.com:443

For the Alert Suppression Rules API, the service name will be AlertSchedulerRuleService.

com.coralogixapis.alerting.alert_scheduler_rule_protobuf.v1.AlertSchedulerRuleService/

The complete request header should look like this:

grpcurl -H "Authorization: Bearer API_KEY_HERE" -d @ ng-api-grpc.coralogix.com:443 com.coralogixapis.alerting.alert_scheduler_rule_protobuf.v1.AlertSchedulerRuleService/

API Endpoints

AlertSchedulerRuleService

Method NameDescription
GetAlertSchedulerRuleRetrieves an alert suppression rule based on the provided rule ID.
CreateAlertSchedulerRuleCreates a new alert suppression rule according to the provided parameters.
UpdateAlertSchedulerRuleUpdates an existing alert suppression rule with new settings and configurations.
DeleteAlertSchedulerRuleDeletes a specified alert suppression rule, removing it from the system.
GetBulkAlertSchedulerRuleRetrieves multiple alert suppression rules in bulk, potentially filtered by various criteria.
CreateBulkAlertSchedulerRuleCreates multiple alert suppression rules in bulk, based on the provided list of rule creation requests.
UpdateBulkAlertSchedulerRuleUpdates multiple existing alert suppression rules with new settings and configurations in bulk.

GetAlertSchedulerRule

Get Alert Scheduler Rule Request

FieldTypeLabelDescription
alert_scheduler_rule_idstringThe rule ID.

GetAlertSchedulerRuleResponse

FieldTypeLabelDescription
alert_scheduler_ruleAlertSchedulerRuleMetadata from the alert rule.

CreateAlertSchedulerRule

CreateAlertSchedulerRuleRequest

FieldTypeLabelDescription
alert_scheduler_ruleAlertSchedulerRuleMetadata from the alert rule

CreateAlertSchedulerRuleResponse

FieldTypeLabelDescription
alert_scheduler_ruleAlertSchedulerRuleMetadata from the alert rule

UpdateAlertSchedulerRule

UpdateAlertSchedulerRuleRequest

FieldTypeLabelDescription
alert_scheduler_ruleAlertSchedulerRuleMetadata from the alert rule

UpdateAlertSchedulerRuleResponse

FieldTypeLabelDescription
alert_scheduler_ruleAlertSchedulerRuleMetadata from the alert rule

DeleteAlertSchedulerRule

DeleteAlertSchedulerRuleRequest

FieldTypeLabelDescription
alert_scheduler_rule_idstringThe rule ID.

DeleteAlertSchedulerRuleResponse

FieldTypeLabelDescription

GetBulkAlertSchedulerRule

GetBulkAlertSchedulerRuleRequest

FieldTypeLabelDescription
active_timeframeActiveTimeframe
enabledbooloptional
alert_scheduler_rules_idsFilterByAlertSchedulerRuleIds
next_page_tokenstringoptional

GetBulkAlertSchedulerRuleResponse

FieldTypeLabelDescription
alert_scheduler_rulesAlertSchedulerRuleWithActiveTimeframerepeated
next_page_tokenstring

CreateBulkAlertSchedulerRule

CreateBulkAlertSchedulerRuleRequest

FieldTypeLabelDescription
create_alert_scheduler_rule_requestsCreateAlertSchedulerRuleRequestrepeated

CreateBulkAlertSchedulerRuleResponse

FieldTypeLabelDescription
create_suppression_responsesCreateAlertSchedulerRuleResponserepeated

UpdateBulkAlertSchedulerRule

UpdateBulkAlertSchedulerRuleRequest

FieldTypeLabelDescription
update_alert_scheduler_rule_requestsUpdateAlertSchedulerRuleRequestrepeated

UpdateBulkAlertSchedulerRuleResponse

FieldTypeLabelDescription
update_suppression_responsesUpdateAlertSchedulerRuleResponserepeated

DeleteBulkAlertSchedulerRule

DeleteBulkAlertSchedulerRuleRequest

FieldTypeLabelDescription
delete_alert_scheduler_rule_requestsDeleteAlertSchedulerRuleRequestrepeated

DeleteBulkAlertSchedulerRuleResponse

FieldTypeLabelDescription

AlertSchedulerRule

FieldTypeLabelDescription
unique_identifierstringoptionalRule unique_identifier: The rule id.
idstringoptionalRule id: The rule version id.
namestringRule name.
descriptionstringoptionalRule description.
meta_labelsMetaLabelrepeatedRule meta_labels: Rule tags over the system.
filterFilterRule filter: The rule filter definition over alert-events.
scheduleScheduleRule schedule: The schedule time definition, how often the rule will be active.
enabledboolRule enabled: The rule activation mode.
created_atstringoptionalRule created_at: The date-time when the rule was created.
updated_atstringoptionalRule updated_at: The date-time when the rule was updated.

AlertSchedulerRuleWithActiveTimeframe

FieldTypeLabelDescription
alert_scheduler_ruleAlertSchedulerRule
next_active_timeframesActiveTimeframerepeated

ActiveTimeframe

FieldTypeLabelDescription
start_timestringTimeframe start time: The point in the time(date-time) when the rule will start to be active.
end_timestringTimeframe end time: The point in the time(date-time) when the rule will finish to be active.
timezonestringTimeframe timezone: The rule will be active according to a specific timezone.

Duration

FieldTypeLabelDescription
for_overint32Duration for_over: The duration interval.
frequencyDurationFrequencyDuration frequency: The duration frequency types (minute hour or day).

Timeframe

FieldTypeLabelDescription
start_timestringTimeframe start time: The point in the time(date-time) when the rule will start to be active.
end_timestringTimeframe end time: The point in the time(date-time) when the rule will finish to be active.
durationDurationTimeframe duration: The duration interval of the rule activation.
timezonestringTimeframe timezone: The rule will be active according to a specific timezone.

DurationFrequency

NameNumberDescription
DURATION_FREQUENCY_UNSPEC

IFIED | 0 | | | DURATION_FREQUENCY_MINUTE | 1 | | | DURATION_FREQUENCY_HOUR | 2 | | | DURATION_FREQUENCY_DAY | 3 | |

Recurring

FieldTypeLabelDescription
alwaysRecurring.Always
dynamicRecurring.Dynamic

Recurring.Always

FieldTypeLabelDescription

Recurring.Dynamic

FieldTypeLabelDescription
repeat_everyint32Recurring Dynamic repeat_every: The rule will be activated in a recurring mode according to the interval.
dailyDaily
weeklyWeekly
monthlyMonthly
timeframeTimeframeRecurring Dynamic timeframe: The rule will be activated in a recurring mode according to the specific timeframe.
termination_datestringoptionalRecurring Dynamic termination_date: The rule will be terminated according to termination_date.

Schedule

FieldTypeLabelDescription
schedule_operationScheduleOperationRule schedule_operation: The rule operation mode (mute/active).
one_timeOneTimeSchedule one_time: The scheduling definition will activate the rule for a specific timeframe.
recurringRecurringSchedule recurring: The scheduling definition will activate the rule for a recurring timeframe.

Daily

FieldTypeLabelDescription

Weekly

FieldTypeLabelDescription
days_of_weekint32repeatedDynamic Weekly days_of_week: The rule will be activated at weekly intervals on specific days in a week.

Monthly

FieldTypeLabelDescription
days_of_monthint32repeatedDynamic Monthly days_of_month: The rule will be activated at monthly intervals on specific days in a month.

OneTime

FieldTypeLabelDescription
timeframeTimeframe

ScheduleOperation

NameNumberDescription
SCHEDULE_OPERATION_UNSPECIFIED0
SCHEDULE_OPERATION_MUTE1
SCHEDULE_OPERATION_ACTIVATE2

FilterByAlertSchedulerRuleIds

FieldTypeLabelDescription
alert_scheduler_idsAlertSchedulerRuleIds
alert_scheduler_version_idsAlertSchedulerRuleVersionIds

AlertSchedulerRuleIds

FieldTypeLabelDescription
alert_scheduler_rule_idsstringrepeated

AlertSchedulerRuleVersionIds

FieldTypeLabelDescription
alert_scheduler_rule_version_idsstringrepeated

Filter

FieldTypeLabelDescription
what_expressionstringFilter what_expression: dataprime expression that filter the alerts group by values.
alert_meta_labelsMetaLabelsFilter alert_meta_labels: filter alerts by meta labels tagging.
alert_unique_idsAlertUniqueIdsFilter alert_unique_ids: filter specific alerts (when alert_unique_ids is empty meaning it wil filter all alerts).

AlertUniqueIds

FieldTypeLabelDescription
valuestringrepeated

MetaLabels

FieldTypeLabelDescription
valueMetaLabelrepeated

MetaLabel

FieldTypeLabelDescription
idstringoptionalMetaLabel id: The meta label id
keystringMetaLabel key: The meta label key
valuestringoptionalMetaLabel value: The meta label value

On this page