• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • Failure detection rules

Settings API - Failure detection rules schema table

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

Configure rules which services certain failure detection parameters should apply to. For more information please refer to Failure detection settings.

Schema IDSchema groupsScope
builtin:failure-detection.environment.rules
  • group:service-monitoring
  • group:failure-detection
environment
Retrieve schema via Settings API
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

PropertyLabelTypeDescriptionRequired
nameRule nametext-required
descriptionRule descriptiontext-optional
enabledEnabledboolean-required
parameterIdFailure detection parameterssetting-required
conditionsConditionsset-required

Request body objects

The predicate object
PropertyLabelTypeDescriptionRequired
predicateTypePredicate typetext-required
textValuesNamesset-required
caseSensitiveCase sensitiveboolean-required
serviceTypeService typesset-required
managementZonesManagement zonesset-required
tagsTags (exact match)set-required
tagKeysTag keysset-required
The condition object
PropertyLabelTypeDescriptionRequired
attributeAttributeenum

The attribute to be checked.

required
predicateCondition to check the attribute againstpredicate-required