Failure detection API - POST a detection rule

Creates a new failure detection rule.

The new rule is appended to the end of the rule list. Rules are evaluated from top to bottom; the first matching rule applies. To enforce a particular order, use the reorder request.

The failure detection parameter set used by the rule must exist at the time of rule creation.

The request produces and consumes an application/json payload.

POSTSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/service/failureDetection/parameterSelection/rules
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/service/failureDetection/parameterSelection/rules

Authentication

To execute this request, you need an access token with WriteConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

The body must not provide an ID. An ID is assigned automatically by Dynatrace and returned as part of the response.

To find all model variations that depend on the type of the model, see JSON models.

Parameter
Type
Description
In
Required
body

The JSON body of the request. Contains the configuration of the new failure detection rule.

Dynatrace will generate a random UUID for you, if you don't specify an ID.

body
optional

Request body objects

The FailureDetectionRule object

Configuration of the failure detection rule.

Element
Type
Description
Required
conditions

A list of conditions of the rule.

The rule applies when all conditions are fulfilled.

required
description
string

A short description of the rule.

optional
enabled
boolean

The rule is enabled (true) or disabled (false).

required
fdpId
string

The failure detection parameter (FDP) set of the rule.

Specify the ID of the set here. The FDP set must exist at the time of rule creation.

required
id
string

The ID of the rule.

optional
name
string

The display name of the rule.

The length of the name is limited to 150 characters.

optional

The FailureDetectionCondition object

The condition of the failure detection rule.

Element
Type
Description
Required
attribute
string

The attribute to be checked.

  • PG_NAME
  • PG_TAG
  • SERVICE_MANAGEMENT_ZONES
  • SERVICE_NAME
  • SERVICE_SERVICE_TYPE
  • SERVICE_TAG
optional
predicate

The predicate that tests the value of the attribute.

The actual set of fields depends on the type of the predicate. Find the list of actual objects in the description of the type field or see Failure detection API - JSON models.

optional

The FdcPredicate object

The predicate that tests the value of the attribute.

The actual set of fields depends on the type of the predicate. Find the list of actual objects in the description of the type field or see Failure detection API - JSON models.

Element
Type
Description
Required
type
string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING_EQUALS -> FdcPredicateStringEquals
  • STRING_STARTS_WITH -> FdcPredicateStringStartsWith
  • STRING_ENDS_WITH -> FdcPredicateStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdcPredicateStringContains
  • INTEGER_EQUALS -> FdcPredicateIntegerEquals
  • INTEGER_LESS_THAN -> FdcPredicateIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdcPredicateIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdcPredicateIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdcPredicateIntegerGreaterThanOrEqual
  • LONG_EQUALS -> FdcPredicateLongEquals
  • LONG_LESS_THAN -> FdcPredicateLongLessThan
  • LONG_LESS_THAN_OR_EQUAL -> FdcPredicateLongLessThanOrEqual
  • LONG_GREATER_THAN -> FdcPredicateLongGreaterThan
  • LONG_GREATER_THAN_OR_EQUAL -> FdcPredicateLongGreaterThanOrEqual
  • TAG_KEY_EQUALS -> FdcPredicateTagKeyEquals
  • TAG_EQUALS -> FdcPredicateTagEquals
  • SERVICE_TYPE_EQUALS -> FdcPredicateServiceTypeEquals
  • MANAGEMENT_ZONES_CONTAINS_ALL -> FdcPredicateManagementZonesContainsAll
  • SET_OF_INTEGERS_CONTAINS_ANY -> FdcPredicateSetOfIntegersContainsAny
  • SET_OF_INTEGERS_CONTAINS_ALL -> FdcPredicateSetOfIntegersContainsAll
  • INTEGER_EQUALS
  • INTEGER_GREATER_THAN
  • INTEGER_GREATER_THAN_OR_EQUAL
  • INTEGER_LESS_THAN
  • INTEGER_LESS_THAN_OR_EQUAL
  • LONG_EQUALS
  • LONG_GREATER_THAN
  • LONG_GREATER_THAN_OR_EQUAL
  • LONG_LESS_THAN
  • LONG_LESS_THAN_OR_EQUAL
  • MANAGEMENT_ZONES_CONTAINS_ALL
  • SERVICE_TYPE_EQUALS
  • SET_OF_INTEGERS_CONTAINS_ALL
  • SET_OF_INTEGERS_CONTAINS_ANY
  • STRING_CONTAINS_SUBSTRING
  • STRING_ENDS_WITH
  • STRING_EQUALS
  • STRING_STARTS_WITH
  • TAG_EQUALS
  • TAG_KEY_EQUALS
required

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

{
  "conditions": [
    {
      "attribute": "SERVICE_NAME",
      "predicate": {
        "ignoreCase": false,
        "type": "STRING_STARTS_WITH",
        "values": [
          "shp",
          "stg_shp"
        ]
      }
    }
  ],
  "description": "for requests from shipping module",
  "enabled": true,
  "fdpId": "FDP_9",
  "id": "R_5",
  "name": "shipping"
}

Response

Response codes

Code
Type
Description
201

Success. The new failure detection rule has been created. The response contains the ID of the new rule.

400

Failed. The input is invalid.

Response body objects

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element
Type
Description
description
string

A short description of the Dynatrace entity.

id
string

The ID of the Dynatrace entity.

name
string

The name of the Dynatrace entity.

Response body JSON model

{
  "description": "Dynatrace entity for the REST API example",
  "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
  "name": "Dynatrace entity"
}

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

The request consumes an application/json payload.

POSTSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/service/failureDetection/parameterSelection/rules/validator
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/service/failureDetection/parameterSelection/rules/validator

Authentication

To execute this request, you need an access token with WriteConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Response

Response codes

Code
Type
Description
204
-

Success. The submitted configuration is valid. Response doesn't have a body.

400

Failed. The input is invalid.