Settings API - Problem alerting profiles schema table

Problem alerting profiles (`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`	`group:alerting`	`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`

Authentication

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.

Parameters

Property	Label	Type	Description	Required
name	Name	text	-	required
managementZone	Management zone	text	Define management zone filter for profile	optional
severityRules	Severity rules	set	Define severity rules for profile. A maximum of 100 severity rules is allowed.	required
eventFilters	Event filters	set	Define event filters for profile. A maximum of 100 event filters is allowed.	required

Request body objects

The `AlertingProfileSeverityRule` object

Property	Label	Type	Description	Required
severityLevel	Problem severity level	enum	-	required
delayInMinutes	Problem send delay in minutes	integer	Send a notification if a problem remains open longer than X minutes.	required
tagFilterIncludeMode	Filter problems by tag	enum	-	required
tagFilter	Tags	set	-	required

The `PredefinedEventFilter` object

Property	Label	Type	Description	Required
eventType	Filter problems by a Dynatrace event type	enum	-	required
negate	Negate	boolean	-	required

The `TextFilter` object

Property	Label	Type	Description	Required
operator	Operator of the comparison	enum	-	required
value	Value	text	-	required
negate	Negate	boolean	-	required
enabled	Enabled	boolean	-	required
caseSensitive	Case sensitive	boolean	-	required

The `MetadataFilterItem` object

Property	Label	Type	Description	Required
metadataKey	Key	text	Type 'dt.' for key hints.	required
metadataValue	Value	text	-	required
negate	Negate	boolean	-	required

The `MetadataFilter` object

Property	Label	Type	Description	Required
metadataFilterItems	-	set	Define filters for event properties. A maximum of 20 properties is allowed.	required

The `CustomEventFilter` object

Property	Label	Type	Description	Required
titleFilter	Title filter	TextFilter	-	optional
descriptionFilter	Description filter	TextFilter	-	optional
metadataFilter	Property filters	MetadataFilter	-	optional

The `AlertingProfileEventFilter` object

Property	Label	Type	Description	Required
type	Filter problems by any event of source	enum	-	required
predefinedFilter	-	PredefinedEventFilter	-	required
customFilter	-	CustomEventFilter	-	required

Settings API - Problem alerting profiles schema table

Problem alerting profiles (builtin:alerting.profile)

Authentication

Parameters

Request body objects

The AlertingProfileSeverityRule object

The PredefinedEventFilter object

The TextFilter object

The MetadataFilterItem object

The MetadataFilter object

The CustomEventFilter object

The AlertingProfileEventFilter object