Settings API - Unified failure detection ruleset schema table

  • Published Sep 25, 2025

Unified failure detection ruleset (builtin:unified-failure-detection-ruleset)

Configure failure detection rules which are evaluated in order until a rule matches.

Dynatrace failure detection automatically detects the vast majority of error conditions in your environment. However, not all services follow the OpenTelemetry specification to heart, so there may be cases where the default span failure detection settings don't meet your particular needs. E.g. your library doesn't use the event 'exception' for exceptions, but another event such as 'fatal-error'. Or you use a custom 'internal.severity' span attribute to transport error information. In such cases, you can configure failure rules which are evaluated in order. As soon as a rule matches, subsequent rules will not be evaluated.

Note: This config applies to your whole tenant and to any span captured by Dynatrace.

For the allowed syntax of the conditions (in Advanced mode) please consider the Dynatrace Query Language (DQL) documentation

Schema IDSchema groupsScope
builtin:unified-failure-detection-ruleset
  • group:service-detection
SERVICE - Service
environment
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:unified-failure-detection-ruleset
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:unified-failure-detection-ruleset
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:unified-failure-detection-ruleset

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

PropertyTypeDescriptionRequired
Enabled
enabled		boolean

The rule will be evaluated.

required
Rule
rule		Rule-required
The Rule object
PropertyTypeDescriptionRequired
Rule name
ruleName		text-required
Rule verdict
spanVerdictIfRuleMatches		enum

Indicates the failure or the success of a span if the rule matches.

  • SPAN_VERDICT_FAILURE
  • SPAN_VERDICT_SUCCESS
required
DQL expression
dqlExpression		text

A DQL match expression. If it evaluates to true, no further rules will be evaluated.

required