Settings API - Failure detection rules schema table

Failure detection rules (builtin:failure-detection.environment.rules)

Configure rules which services certain failure detection parameters (<your-dynatrace-url>//ui/settings/builtin:failure-detection.environment.parameters) should apply to. For more information please refer to Failure detection settings.

These settings are not applied to Unified services.

Schema ID
Schema groups
Scope
builtin:failure-detection.environment.rules
  • group:service-monitoring
  • group:failure-detection
environment
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:failure-detection.environment.rules
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:failure-detection.environment.rules
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:failure-detection.environment.rules

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
Type
Description
Required
Rule name
name
text
-
required
Rule description
description
text
-
optional
Enabled
enabled
boolean
-
required
Failure detection parameters
parameterId
setting
-
required
Conditions
conditions
-
required
The condition object
Property
Type
Description
Required
Attribute
attribute
enum

The attribute to be checked.

  • PG_NAME
  • PG_TAG
  • SERVICE_MANAGEMENT_ZONE
  • SERVICE_NAME
  • SERVICE_TYPE
  • SERVICE_TAG
required
Condition to check the attribute against
predicate
-
required
The predicate object
Property
Type
Description
Required
Predicate type
predicateType
text
-
required
Names
textValues
set
-
required
Case sensitive
caseSensitive
boolean
-
required
Service types
serviceType
  • WebRequest
  • WebService
  • Database
  • Method
  • WebSite
  • Messaging
  • Mobile
  • Process
  • RMI
  • External
  • QueueListener
  • QueueInteraction
  • RemoteCall
  • SaasVendor
  • AMP
  • CustomApplication
  • CICS
  • IMS
  • CICSInteraction
  • IMSInteraction
  • EnterpriseServiceBus
  • zOSConnect
required
Management zones
managementZones
set
-
required
Tags (exact match)
tags
set
-
required
Tag keys
tagKeys
set
-
required