builtin:alerting.profile)
Alerting profiles enable you to set up fine-grained alert-filtering rules that are based on the severity, customer impact, associated tags, and/or duration of detected problems. Alerting profiles enable you to control exactly which conditions result in problem notifications and which don't. This includes all problem-push notifications that are sent via the Dynatrace mobile app and displayed in the Dynatrace web UI. Alerting profiles can also be used to set up filtered problem-notification integrations with 3rd party messaging systems like Slack, VictorOps, and PagerDuty.
Schema ID | Schema groups | Scope |
---|---|---|
builtin:alerting.profile |
| environment |
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:alerting.profile |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:alerting.profile | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:alerting.profile |
To execute this request, you need an access token with Read settings (settings.read
) scope. To learn how to obtain and use it, see Tokens and authentication.
Property | Type | Description | Required |
---|---|---|---|
Namename | text | - | required |
Management zonemanagementZone | setting | Entities which are part of the configured management zones will match this alerting profile. It is recommended to use manual tags instead. Note: Management zones may experience delays or inconsistencies due to rule complexity and attribute variability. Entities may not be immediately assigned to management zones, impacting filter effectiveness. It is recommended to use manual tags instead. For more information, visit our best practices for management zones documentation page. | optional |
Severity rulesseverityRules | Set<AlertingProfileSeverityRule> | Define severity rules for profile. A maximum of 100 severity rules is allowed. | required |
Event filterseventFilters | Set<AlertingProfileEventFilter> | Define event filters for profile. A maximum of 100 event filters is allowed. | required |
AlertingProfileSeverityRule
objectProperty | Type | Description | Required |
---|---|---|---|
Problem severity levelseverityLevel | enum |
| required |
Problem send delay in minutesdelayInMinutes | integer | Send a notification if a problem remains open longer than X minutes. | required |
Filter problems by tagtagFilterIncludeMode | enum |
| required |
TagstagFilter | set | Entities which contain any/all of the configured tags will match this alerting profile. It is recommended to use manual tags. Note: Automatically applied tags may experience delays or inconsistencies due to rule complexity and attribute variability. Entities may not be immediately tagged, impacting filter effectiveness. It is recommended to use manual tags instead. For more information, visit our best practices for tagging documentation page. | required |
AlertingProfileEventFilter
objectProperty | Type | Description | Required |
---|---|---|---|
Filter problems by any event of sourcetype | enum |
| required |
predefinedFilter | PredefinedEventFilter | - | required |
customFilter | CustomEventFilter | - | required |
PredefinedEventFilter
objectProperty | Type | Description | Required |
---|---|---|---|
Filter problems by a Dynatrace event typeeventType | enum |
| required |
Negatenegate | boolean | - | required |
CustomEventFilter
objectProperty | Type | Description | Required |
---|---|---|---|
Title filtertitleFilter | TextFilter | - | optional |
Description filterdescriptionFilter | TextFilter | - | optional |
Property filtersmetadataFilter | MetadataFilter | - | optional |
TextFilter
objectProperty | Type | Description | Required |
---|---|---|---|
Operator of the comparisonoperator | enum |
| required |
Valuevalue | text | - | required |
Negatenegate | boolean | - | required |
Enabledenabled | boolean | - | required |
Case sensitivecaseSensitive | boolean | - | required |
MetadataFilter
objectProperty | Type | Description | Required |
---|---|---|---|
metadataFilterItems | Set<MetadataFilterItem> | Define filters for event properties. A maximum of 20 properties is allowed. | required |
MetadataFilterItem
objectProperty | Type | Description | Required |
---|---|---|---|
KeymetadataKey | text | Type 'dt.' for key hints. | required |
ValuemetadataValue | text | - | required |
Negatenegate | boolean | - | required |