Failure detection API - POST a parameter set

Creates a new failure detection parameter set.

The request consumes and produces an application/json payload.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

POST

Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/service/failureDetection/parameterSelection/parameterSets
SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/service/failureDetection/parameterSelection/parameterSets
Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/service/failureDetection/parameterSelection/parameterSets

Authentication

To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

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

Parameter	Type	Description	In	Required
body	FailureDetectionParameterSet	The JSON body of the request. Contains the new failure detection parameter set. Dynatrace does not generate the ID automatically; you must specify it.	body	optional

Parameter

Type

Description

Required

body

FailureDetectionParameterSet

The JSON body of the request. Contains the new failure detection parameter set.

Dynatrace does not generate the ID automatically; you must specify it.

body

optional

Body format

Request parametersJSON model

The FailureDetectionParameterSet object

A set of failure detection parameters (FDP).

These parameters define the conditions of failure and success.

Element	Type	Description	Required
id	string	The ID of the parameter set. The allowed characters are lowercase and uppercase letters, numbers, hyphens (`-`), and underscores (`_`). The length is limited to 30 characters.	optional
name	string	The display name of the FDP set. The length of the name is limited to 150 characters.	optional
description	string	A short description of the FDP set.	optional
clientSideMissingHttpCodeIsFailure	boolean	The missing HTTP response code on the client side is a failure (`true`) or a success (`false`). If not set, `false` is used.	optional
serverSideMissingHttpCodeIsFailure	boolean	The missing HTTP response code on the server side is a failure (`true`) or a success (`false`). If not set, `false` is used.	optional
failingHttpCodesClientSide	string	A list of client side HTTP response codes that are considered a failure. The format is a list of ranges and individual values (for example, `500-599, 400-499, 1008`). If not set, the range of `400-599` is used.	optional
failingHttpCodesServerSide	string	A list of server side HTTP response codes that are considered a failure. The format is a list of ranges and individual values (for example, `500-599, 400-499, 1008`).If not set, the range of `500-599` is used.	optional
http404NotFoundFailureEnabled	boolean	Special handling of the 404 HTTP response code is enabled (`true`) or disabled (`false`). See brokenLinkDomains for special handling details. Only applicable when 404 is NOT in the list of failing HTTP response codes and only for the server side. If not set, `false` is used.	optional
brokenLinkDomains	string[]	A list of domains for the special handling of the 404 HTTP response code. If the top domain of the Referer is presented in the list OR equals the top domain of the request's host, the 404 code is considered a failure. Only applicable when isHttp404NotFoundFailureEnabled is set to `true`.	optional
successForcingExceptionPatterns	ExceptionPattern[]	A list of success exceptions. If an exception on the entry node of the service matches any of these patterns it is considered a success.	optional
ignoredExceptionPatterns	ExceptionPattern[]	A list of ignored exceptions. If an exception on the entry node of the service matches any of these patterns it is ignored by failure detection.	optional
exceptionOnAnyNodeExceptionPatterns	ExceptionPattern[]	A list of faulty exceptions. If an exception on any node of the service matches any of these patterns it is considered a failure.	optional
tagConditions	FdpTagCondition[]	A list of tag-based conditions. If any condition is fulfilled the request is considered a failure.	optional

The FdpTagCondition object

Configuration of the tag condition in the FDP set.

Element	Type	Description	Required
tagKey	string	The key of the tag to be checked.	required
predicate	FdpTagPredicate		required

The FdpTagPredicate object

The predicate that tests the value of the tag.

The actual set of fields depends on the type of the predicate. Find the list of actual models in the description of the type field and check the description of the model you need.

Element Type Description Required

type

string

Element	Type	Description	Required
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `STRING_EQUALS` -> FdpTagStringEquals `STRING_STARTS_WITH` -> FdpTagStringStartsWith `STRING_ENDS_WITH` -> FdpTagStringEndsWith `STRING_CONTAINS_SUBSTRING` -> FdpTagStringContainsSubstring `INTEGER_EQUALS` -> FdpTagIntegerEquals `INTEGER_LESS_THAN` -> FdpTagIntegerLessThan `INTEGER_LESS_THAN_OR_EQUAL` -> FdpTagIntegerLessThanOrEqual `INTEGER_GREATER_THAN` -> FdpTagIntegerGreaterThan `INTEGER_GREATER_THAN_OR_EQUAL` -> FdpTagIntegerGreaterThanOrEqual `DOUBLE_EQUALS` -> FdpTagDoubleEquals `DOUBLE_LESS_THAN` -> FdpTagDoubleLessThan `DOUBLE_LESS_THAN_OR_EQUAL` -> FdpTagDoubleLessThanOrEqual `DOUBLE_GREATER_THAN` -> FdpTagDoubleGreaterThan `DOUBLE_GREATER_THAN_OR_EQUAL` -> FdpTagDoubleGreaterThanOrEqual The element can hold these values DOUBLE_EQUALS DOUBLE_GREATER_THAN DOUBLE_GREATER_THAN_OR_EQUAL DOUBLE_LESS_THAN DOUBLE_LESS_THAN_OR_EQUAL INTEGER_EQUALS INTEGER_GREATER_THAN INTEGER_GREATER_THAN_OR_EQUAL INTEGER_LESS_THAN INTEGER_LESS_THAN_OR_EQUAL STRING_CONTAINS_SUBSTRING STRING_ENDS_WITH STRING_EQUALS STRING_STARTS_WITH	required

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

STRING_EQUALS -> FdpTagStringEquals
STRING_STARTS_WITH -> FdpTagStringStartsWith
STRING_ENDS_WITH -> FdpTagStringEndsWith
STRING_CONTAINS_SUBSTRING -> FdpTagStringContainsSubstring
INTEGER_EQUALS -> FdpTagIntegerEquals
INTEGER_LESS_THAN -> FdpTagIntegerLessThan
INTEGER_LESS_THAN_OR_EQUAL -> FdpTagIntegerLessThanOrEqual
INTEGER_GREATER_THAN -> FdpTagIntegerGreaterThan
INTEGER_GREATER_THAN_OR_EQUAL -> FdpTagIntegerGreaterThanOrEqual
DOUBLE_EQUALS -> FdpTagDoubleEquals
DOUBLE_LESS_THAN -> FdpTagDoubleLessThan
DOUBLE_LESS_THAN_OR_EQUAL -> FdpTagDoubleLessThanOrEqual
DOUBLE_GREATER_THAN -> FdpTagDoubleGreaterThan
DOUBLE_GREATER_THAN_OR_EQUAL -> FdpTagDoubleGreaterThanOrEqual

The element can hold these values

DOUBLE_EQUALS
DOUBLE_GREATER_THAN
DOUBLE_GREATER_THAN_OR_EQUAL
DOUBLE_LESS_THAN
DOUBLE_LESS_THAN_OR_EQUAL
INTEGER_EQUALS
INTEGER_GREATER_THAN
INTEGER_GREATER_THAN_OR_EQUAL
INTEGER_LESS_THAN
INTEGER_LESS_THAN_OR_EQUAL
STRING_CONTAINS_SUBSTRING
STRING_ENDS_WITH
STRING_EQUALS
STRING_STARTS_WITH

required

The ExceptionPattern object

A list of faulty exceptions.

If an exception on any node of the service matches any of these patterns it is considered a failure.

Element	Type	Description	Required
classPattern	string		optional
messagePattern	string		optional

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

      {
  "id": "FDP_9",
  "name": "shipping",
  "description": "for requests from shipping module\n",
  "clientSideMissingHttpCodeIsFailure": false,
  "serverSideMissingHttpCodeIsFailure": false,
  "failingHttpCodesClientSide": "400-599",
  "failingHttpCodesServerSide": "500-599",
  "http404NotFoundFailureEnabled": false,
  "brokenLinkDomains": [
    "mydomain.com"
  ],
  "successForcingExceptionPatterns": [
    {
      "classPattern": "NullPointerException",
      "messagePattern": ""
    }
  ],
  "tagConditions": [
    {
      "tagKey": "myTag",
      "predicate": {
        "type": "STRING_EQUALS",
        "value": "NG",
        "ignoreCase": true
      }
    }
  ]
}

Response

Response codes

Code	Description
201	Success. The new failure detection parameter set has been created. The response contains the ID of the new set.
400	Failed. The input is invalid.

Response body

Response parametersJSON model

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element	Type	Description
id	string	The ID of the Dynatrace entity.
name	string	The name of the Dynatrace entity.
description	string	A short description of the Dynatrace entity.

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

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.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

POST

Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/service/failureDetection/parameterSelection/parameterSets/validator
SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/service/failureDetection/parameterSelection/parameterSets/validator
Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/service/failureDetection/parameterSelection/parameterSets/validator

Authentication

To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Response

Response codes

Code	Description
204	Success. The configuration has been updated. Response doesn't have a body.
400	Failed. The input is invalid.

Response body

A successful request doesn't return any content.