Interface CreateAlertRuleOptions

interface CreateAlertRuleOptions {
    description?: string;
    domain?: AlertDomain;
    enabled?: boolean;
    name: string;
    notificationChannelIds?: string[];
    ruleConfig: AlertRuleConfig;
    severity: AlertSeverity;
    summary?: string;
    timeAggregation?: string;
}

Index

Properties

description? domain? enabled? name notificationChannelIds? ruleConfig severity summary? timeAggregation?

Properties

`Optional`description

description?: string

`Optional`domain

domain?: AlertDomain

`Optional`enabled

enabled?: boolean

Controls whether the alert is active. NOTE: surfaces as status ("active"/"paused"), not as a returned enabled field.

name

name: string

`Optional`notificationChannelIds

notificationChannelIds?: string[]

ruleConfig

ruleConfig: AlertRuleConfig

severity

severity: AlertSeverity

`Optional`summary

summary?: string

Applied to the underlying alert, but not stored on / returned by the rule record.

`Optional`timeAggregation

timeAggregation?: string

Used when building the alert query, but not persisted on the rule record.