# Alert Suppression Rules API Copy as Markdown[Open in ChatGPT](https://chatgpt.com/?q=Read%20https%3A%2F%2Fdocs-docusaurus.kinsta.page%2Fdeveloper-portal%2Fapis%2Fdata-management%2Falert-suppression-rules-api.md%20and%20help%20me%20with%20my%20question%20about%20this%20Coralogix%20documentation%20page.)[Open in Claude](https://claude.ai/new?q=Read%20https%3A%2F%2Fdocs-docusaurus.kinsta.page%2Fdeveloper-portal%2Fapis%2Fdata-management%2Falert-suppression-rules-api.md%20and%20help%20me%20with%20my%20question%20about%20this%20Coralogix%20documentation%20page.) ## Overview[​](#overview "Direct link to 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[​](#prerequisites "Direct link to Prerequisites") Before you begin, please make sure you have the following: * [API Key for Alerts, Rules & Tags](https://docs-docusaurus.kinsta.page/user-guides/account-management/api-keys/api-keys/.md) to successfully authenticate * Choose the api.:443 endpoint that corresponds to your Coralogix [domain](https://docs-docusaurus.kinsta.page/user-guides/account-management/account-settings/coralogix-domain/.md) using the domain selector at the top of the page. * Administrator permissions to manage your services ## Authentication[​](#authentication "Direct link to Authentication") Coralogix API uses API keys to authenticate requests. You can view and [manage your API keys](https://docs-docusaurus.kinsta.page/user-guides/account-management/api-keys/api-keys/.md) from the Data Flow tab in Coralogix. You need to use this API key in the Authorization request header to successfully connect. Then, use the api.:443 endpoint that corresponds to your Coralogix [domain](https://docs-docusaurus.kinsta.page/user-guides/account-management/account-settings/coralogix-domain/.md) to structure your header. For the Alert Suppression Rules API, the service name will be `AlertSchedulerRuleService`, and with its namespace becomes `com.coralogixapis.alerting.alert_scheduler_rule_protobuf.v1.AlertSchedulerRuleService`. The request header base should look like this: ``` grpcurl -H "Authorization: Bearer " -d @ api.eu2.coralogix.com:443 com.coralogixapis.alerting.alert_scheduler_rule_protobuf.v1.AlertSchedulerRuleService ``` The complete request header should also contain a specific API endpoint. For example, to create a rule use the following: ``` grpcurl -H "Authorization: Bearer " -d @ api.eu2.coralogix.com:443 com.coralogixapis.alerting.alert_scheduler_rule_protobuf.v1.AlertSchedulerRuleService/CreateAlertSchedulerRule ``` ## API endpoints[​](#api-endpoints "Direct link to API endpoints") ### AlertSchedulerRuleService[​](#alertschedulerruleservice "Direct link to AlertSchedulerRuleService") | Method Name | Description | | ---------------------------- | ------------------------------------------------------------------------------------------------------- | | GetAlertSchedulerRule | Retrieves an alert suppression rule based on the provided rule ID. | | CreateAlertSchedulerRule | Creates a new alert suppression rule according to the provided parameters. | | UpdateAlertSchedulerRule | Updates an existing alert suppression rule with new settings and configurations. | | DeleteAlertSchedulerRule | Deletes a specified alert suppression rule, removing it from the system. | | GetBulkAlertSchedulerRule | Retrieves multiple alert suppression rules in bulk, potentially filtered by various criteria. | | CreateBulkAlertSchedulerRule | Creates multiple alert suppression rules in bulk, based on the provided list of rule creation requests. | | UpdateBulkAlertSchedulerRule | Updates multiple existing alert suppression rules with new settings and configurations in bulk. | ### GetAlertSchedulerRule[​](#getalertschedulerrule "Direct link to GetAlertSchedulerRule") ### Get Alert Scheduler Rule Request[​](#get-alert-scheduler-rule-request "Direct link to Get Alert Scheduler Rule Request") | Field | Type | Label | Description | | -------------------------- | ------ | ----- | ------------ | | alert\_scheduler\_rule\_id | string | | The rule ID. | ### GetAlertSchedulerRuleResponse[​](#getalertschedulerruleresponse "Direct link to GetAlertSchedulerRuleResponse") | Field | Type | Label | Description | | ---------------------- | ------------------ | ----- | ----------------------------- | | alert\_scheduler\_rule | AlertSchedulerRule | | Metadata from the alert rule. | ### CreateAlertSchedulerRule[​](#createalertschedulerrule "Direct link to CreateAlertSchedulerRule") ### CreateAlertSchedulerRuleRequest[​](#createalertschedulerrulerequest "Direct link to CreateAlertSchedulerRuleRequest") | Field | Type | Label | Description | | ---------------------- | ------------------ | ----- | ---------------------------- | | alert\_scheduler\_rule | AlertSchedulerRule | | Metadata from the alert rule | ### CreateAlertSchedulerRuleResponse[​](#createalertschedulerruleresponse "Direct link to CreateAlertSchedulerRuleResponse") | Field | Type | Label | Description | | ---------------------- | ------------------ | ----- | ---------------------------- | | alert\_scheduler\_rule | AlertSchedulerRule | | Metadata from the alert rule | ### UpdateAlertSchedulerRule[​](#updatealertschedulerrule "Direct link to UpdateAlertSchedulerRule") ### UpdateAlertSchedulerRuleRequest[​](#updatealertschedulerrulerequest "Direct link to UpdateAlertSchedulerRuleRequest") | Field | Type | Label | Description | | ---------------------- | ------------------ | ----- | ---------------------------- | | alert\_scheduler\_rule | AlertSchedulerRule | | Metadata from the alert rule | ### UpdateAlertSchedulerRuleResponse[​](#updatealertschedulerruleresponse "Direct link to UpdateAlertSchedulerRuleResponse") | Field | Type | Label | Description | | ---------------------- | ------------------ | ----- | ---------------------------- | | alert\_scheduler\_rule | AlertSchedulerRule | | Metadata from the alert rule | ### DeleteAlertSchedulerRule[​](#deletealertschedulerrule "Direct link to DeleteAlertSchedulerRule") ### DeleteAlertSchedulerRuleRequest[​](#deletealertschedulerrulerequest "Direct link to DeleteAlertSchedulerRuleRequest") | Field | Type | Label | Description | | -------------------------- | ------ | ----- | ------------ | | alert\_scheduler\_rule\_id | string | | The rule ID. | ### DeleteAlertSchedulerRuleResponse[​](#deletealertschedulerruleresponse "Direct link to DeleteAlertSchedulerRuleResponse") | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | | | | | ### GetBulkAlertSchedulerRule[​](#getbulkalertschedulerrule "Direct link to GetBulkAlertSchedulerRule") ### GetBulkAlertSchedulerRuleRequest[​](#getbulkalertschedulerrulerequest "Direct link to GetBulkAlertSchedulerRuleRequest") | Field | Type | Label | Description | | ---------------------------- | ----------------------------- | -------- | ----------- | | active\_timeframe | ActiveTimeframe | | | | enabled | bool | optional | | | alert\_scheduler\_rules\_ids | FilterByAlertSchedulerRuleIds | | | | next\_page\_token | string | optional | | ### GetBulkAlertSchedulerRuleResponse[​](#getbulkalertschedulerruleresponse "Direct link to GetBulkAlertSchedulerRuleResponse") | Field | Type | Label | Description | | ----------------------- | ------------------------------------- | -------- | ----------- | | alert\_scheduler\_rules | AlertSchedulerRuleWithActiveTimeframe | repeated | | | next\_page\_token | string | | | ### CreateBulkAlertSchedulerRule[​](#createbulkalertschedulerrule "Direct link to CreateBulkAlertSchedulerRule") ### CreateBulkAlertSchedulerRuleRequest[​](#createbulkalertschedulerrulerequest "Direct link to CreateBulkAlertSchedulerRuleRequest") | Field | Type | Label | Description | | ---------------------------------------- | ------------------------------- | -------- | ----------- | | create\_alert\_scheduler\_rule\_requests | CreateAlertSchedulerRuleRequest | repeated | | ### CreateBulkAlertSchedulerRuleResponse[​](#createbulkalertschedulerruleresponse "Direct link to CreateBulkAlertSchedulerRuleResponse") | Field | Type | Label | Description | | ------------------------------ | -------------------------------- | -------- | ----------- | | create\_suppression\_responses | CreateAlertSchedulerRuleResponse | repeated | | ### UpdateBulkAlertSchedulerRule[​](#updatebulkalertschedulerrule "Direct link to UpdateBulkAlertSchedulerRule") ### UpdateBulkAlertSchedulerRuleRequest[​](#updatebulkalertschedulerrulerequest "Direct link to UpdateBulkAlertSchedulerRuleRequest") | Field | Type | Label | Description | | ---------------------------------------- | ------------------------------- | -------- | ----------- | | update\_alert\_scheduler\_rule\_requests | UpdateAlertSchedulerRuleRequest | repeated | | ### UpdateBulkAlertSchedulerRuleResponse[​](#updatebulkalertschedulerruleresponse "Direct link to UpdateBulkAlertSchedulerRuleResponse") | Field | Type | Label | Description | | ------------------------------ | -------------------------------- | -------- | ----------- | | update\_suppression\_responses | UpdateAlertSchedulerRuleResponse | repeated | | ### DeleteBulkAlertSchedulerRule[​](#deletebulkalertschedulerrule "Direct link to DeleteBulkAlertSchedulerRule") ### DeleteBulkAlertSchedulerRuleRequest[​](#deletebulkalertschedulerrulerequest "Direct link to DeleteBulkAlertSchedulerRuleRequest") | Field | Type | Label | Description | | ---------------------------------------- | ------------------------------- | -------- | ----------- | | delete\_alert\_scheduler\_rule\_requests | DeleteAlertSchedulerRuleRequest | repeated | | ### DeleteBulkAlertSchedulerRuleResponse[​](#deletebulkalertschedulerruleresponse "Direct link to DeleteBulkAlertSchedulerRuleResponse") | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | | | | | ### AlertSchedulerRule[​](#alertschedulerrule "Direct link to AlertSchedulerRule") | Field | Type | Label | Description | | ------------------ | --------- | -------- | ------------------------------------------------------------------------------- | | unique\_identifier | string | optional | Rule unique\_identifier: The rule id. | | id | string | optional | Rule id: The rule version id. | | name | string | | Rule name. | | description | string | optional | Rule description. | | meta\_labels | MetaLabel | repeated | Rule meta\_labels: Rule tags over the system. | | filter | Filter | | Rule filter: The rule filter definition over alert-events. | | schedule | Schedule | | Rule schedule: The schedule time definition, how often the rule will be active. | | enabled | bool | | Rule enabled: The rule activation mode. | | created\_at | string | optional | Rule created\_at: The date-time when the rule was created. | | updated\_at | string | optional | Rule updated\_at: The date-time when the rule was updated. | ### AlertSchedulerRuleWithActiveTimeframe[​](#alertschedulerrulewithactivetimeframe "Direct link to AlertSchedulerRuleWithActiveTimeframe") | Field | Type | Label | Description | | ------------------------ | ------------------ | -------- | ----------- | | alert\_scheduler\_rule | AlertSchedulerRule | | | | next\_active\_timeframes | ActiveTimeframe | repeated | | ### ActiveTimeframe[​](#activetimeframe "Direct link to ActiveTimeframe") | Field | Type | Label | Description | | ----------- | ------ | ----- | --------------------------------------------------------------------------------------------- | | start\_time | string | | Timeframe start time: The point in the time(date-time) when the rule will start to be active. | | end\_time | string | | Timeframe end time: The point in the time(date-time) when the rule will finish to be active. | | timezone | string | | Timeframe timezone: The rule will be active according to a specific timezone. | ### Duration[​](#duration "Direct link to Duration") | Field | Type | Label | Description | | --------- | ----------------- | ----- | ---------------------------------------------------------------------- | | for\_over | int32 | | Duration for\_over: The duration interval. | | frequency | DurationFrequency | | Duration frequency: The duration frequency types (minute hour or day). | ### Timeframe[​](#timeframe "Direct link to Timeframe") | Field | Type | Label | Description | | ----------- | -------- | ----- | --------------------------------------------------------------------------------------------- | | start\_time | string | | Timeframe start time: The point in the time(date-time) when the rule will start to be active. | | end\_time | string | | Timeframe end time: The point in the time(date-time) when the rule will finish to be active. | | duration | Duration | | Timeframe duration: The duration interval of the rule activation. | | timezone | string | | Timeframe timezone: The rule will be active according to a specific timezone. | Note Avoid including time zone indicators (like 'Z' for UTC) in the `start_time` and `end_time` fields. For example, use `2025-05-21T22:41:26` instead of `2025-05-21T22:41:26Z`. ### DurationFrequency[​](#durationfrequency "Direct link to DurationFrequency") | Name | Number | | -------------------------------- | ------ | | DURATION\_FREQUENCY\_UNSPECIFIED | 0 | | DURATION\_FREQUENCY\_MINUTE | 1 | | DURATION\_FREQUENCY\_HOUR | 2 | | DURATION\_FREQUENCY\_DAY | 3 | ### Recurring[​](#recurring "Direct link to Recurring") | Field | Type | Label | Description | | ------- | ----------------- | ----- | ----------- | | always | Recurring.Always | | | | dynamic | Recurring.Dynamic | | | ### Recurring.Always[​](#recurringalways "Direct link to Recurring.Always") | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | | | | | ### Recurring.Dynamic[​](#recurringdynamic "Direct link to Recurring.Dynamic") | Field | Type | Label | Description | | ----------------- | --------- | -------- | ---------------------------------------------------------------------------------------------------------------- | | repeat\_every | int32 | | Recurring Dynamic repeat\_every: The rule will be activated in a recurring mode according to the interval. | | daily | Daily | | | | weekly | Weekly | | | | monthly | Monthly | | | | timeframe | Timeframe | | Recurring Dynamic timeframe: The rule will be activated in a recurring mode according to the specific timeframe. | | termination\_date | string | optional | Recurring Dynamic termination\_date: The rule will be terminated according to termination\_date. | ### Schedule[​](#schedule "Direct link to Schedule") | Field | Type | Label | Description | | ------------------- | ----------------- | ----- | ----------------------------------------------------------------------------------------------- | | schedule\_operation | ScheduleOperation | | Rule schedule\_operation: The rule operation mode (mute/active). | | one\_time | OneTime | | Schedule one\_time: The scheduling definition will activate the rule for a specific timeframe. | | recurring | Recurring | | Schedule recurring: The scheduling definition will activate the rule for a recurring timeframe. | ### Daily[​](#daily "Direct link to Daily") | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | | | | | ### Weekly[​](#weekly "Direct link to Weekly") | Field | Type | Label | Description | | -------------- | ----- | -------- | --------------------------------------------------------------------------------------------------------- | | days\_of\_week | int32 | repeated | Dynamic Weekly days\_of\_week: The rule will be activated at weekly intervals on specific days in a week. | ### Monthly[​](#monthly "Direct link to Monthly") | Field | Type | Label | Description | | --------------- | ----- | -------- | ------------------------------------------------------------------------------------------------------------- | | days\_of\_month | int32 | repeated | Dynamic Monthly days\_of\_month: The rule will be activated at monthly intervals on specific days in a month. | ### OneTime[​](#onetime "Direct link to OneTime") | Field | Type | Label | Description | | --------- | --------- | ----- | ----------- | | timeframe | Timeframe | | | ### ScheduleOperation[​](#scheduleoperation "Direct link to ScheduleOperation") | Name | Number | Description | | -------------------------------- | ------ | ----------- | | SCHEDULE\_OPERATION\_UNSPECIFIED | 0 | | | SCHEDULE\_OPERATION\_MUTE | 1 | | | SCHEDULE\_OPERATION\_ACTIVATE | 2 | | ### FilterByAlertSchedulerRuleIds[​](#filterbyalertschedulerruleids "Direct link to FilterByAlertSchedulerRuleIds") | Field | Type | Label | Description | | ------------------------------ | ---------------------------- | ----- | ----------- | | alert\_scheduler\_ids | AlertSchedulerRuleIds | | | | alert\_scheduler\_version\_ids | AlertSchedulerRuleVersionIds | | | ### AlertSchedulerRuleIds[​](#alertschedulerruleids "Direct link to AlertSchedulerRuleIds") | Field | Type | Label | Description | | --------------------------- | ------ | -------- | ----------- | | alert\_scheduler\_rule\_ids | string | repeated | | ### AlertSchedulerRuleVersionIds[​](#alertschedulerruleversionids "Direct link to AlertSchedulerRuleVersionIds") | Field | Type | Label | Description | | ------------------------------------ | ------ | -------- | ----------- | | alert\_scheduler\_rule\_version\_ids | string | repeated | | ### Filter[​](#filter "Direct link to Filter") | Field | Type | Label | Description | | ------------------- | -------------- | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | what\_expression | string | | Filter what\_expression: [DPXL expression](https://docs-docusaurus.kinsta.page/dataprime/user-guide/dpxl/.md) that filters the alerts group by values. | | alert\_meta\_labels | MetaLabels | | Filter alert\_meta\_labels: filter alerts by meta labels tagging. | | alert\_unique\_ids | AlertUniqueIds | | Filter alert\_unique\_ids: filter specific alerts (when alert\_unique\_ids is empty meaning it wil filter all alerts). | ### AlertUniqueIds[​](#alertuniqueids "Direct link to AlertUniqueIds") | Field | Type | Label | Description | | ----- | ------ | -------- | ----------- | | value | string | repeated | | ### MetaLabels[​](#metalabels "Direct link to MetaLabels") | Field | Type | Label | Description | | ----- | --------- | -------- | ----------- | | value | MetaLabel | repeated | | ### MetaLabel[​](#metalabel "Direct link to MetaLabel") | Field | Type | Label | Description | | ----- | ------ | -------- | ------------------------------------- | | id | string | optional | MetaLabel id: The meta label id | | key | string | | MetaLabel key: The meta label key | | value | string | optional | MetaLabel value: The meta label value | ## Additional resources[​](#additional-resources "Direct link to Additional resources") | | | | ------------------- | ----------------------------------------------------------------------------------------------- | | Coralogix Endpoints | [Coralogix Endpoints](https://docs-docusaurus.kinsta.page/integrations/coralogix-endpoints/.md) |