• Home
  • Dynatrace API
  • Configuration
  • Services
  • Failure detection
  • Parameter set
  • PUT a parameter set

Failure detection API - PUT a parameter set

Updates the specified failure detection parameter set.

The request consumes an application/json payload.

Early Adopter

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

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

Authentication

To execute this request, you need an access token with Write configuration (WriteConfig) scope. 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.

ParameterTypeDescriptionInRequired
idstring

The ID of the required failure detection parameter set.

pathrequired
bodyFailureDetectionParameterSet

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

You can't update the ID with this request. Use the change ID request instead.

bodyoptional

Request body objects

The FailureDetectionParameterSet object

A set of failure detection parameters (FDP).

These parameters define the conditions of failure and success.

ElementTypeDescription
idstring

The ID of the parameter set.

Can be null.

namestring

The display name of the FDP set.

The length of the name is limited to 150 characters.

Can be null.

descriptionstring

A short description of the FDP set.

Can be null.

clientSideMissingHttpCodeIsFailureboolean

The missing HTTP response code on the client side is a failure (true) or a success (false).

If not set, false is used.

Can be null.

serverSideMissingHttpCodeIsFailureboolean

The missing HTTP response code on the server side is a failure (true) or a success (false).

If not set, false is used.

Can be null.

failingHttpCodesClientSidestring

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.

Can be null.

failingHttpCodesServerSidestring

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.

Can be null.

http404NotFoundFailureEnabledboolean

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.

Can be null.

brokenLinkDomainsstring[]

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.

Can be null.

ignoreAllExceptionsboolean

If set to true all exceptions will be ignored. Which means defined exception patterns will not have any effect.

Can be null.

successForcingExceptionPatternsExceptionPattern[]

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.

Can be null.

ignoredExceptionPatternsExceptionPattern[]

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.

Can be null.

exceptionOnAnyNodeExceptionPatternsExceptionPattern[]

A list of faulty exceptions.

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

Can be null.

tagConditionsFdpTagCondition[]

A list of tag-based conditions.

If any condition is fulfilled the request is considered a failure.

Can be null.

ignoreSpanFailureDetectionboolean

If set to true span failure detection will be ignored.

Can be null.

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.

ElementTypeDescription
classPatternstring-

Can be null.

messagePatternstring-

Can be null.

The FdpTagCondition object

Configuration of the tag condition in the FDP set.

ElementTypeDescription
tagKeystring

The key of the tag to be checked.

predicateFdpTagPredicate

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 objects in the description of the type field or see Failure detection API - JSON models.

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 objects in the description of the type field or see Failure detection API - JSON models.

ElementTypeDescription
typestring

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

  • STRING_EXISTS -> FdpTagStringExists
  • STRING_EQUALS -> FdpTagStringEquals
  • STRING_STARTS_WITH -> FdpTagStringStartsWith
  • STRING_ENDS_WITH -> FdpTagStringEndsWith
  • STRING_CONTAINS_SUBSTRING -> FdpTagStringContainsSubstring
  • INTEGER_EXISTS -> FdpTagIntegerExists
  • INTEGER_EQUALS -> FdpTagIntegerEquals
  • INTEGER_LESS_THAN -> FdpTagIntegerLessThan
  • INTEGER_LESS_THAN_OR_EQUAL -> FdpTagIntegerLessThanOrEqual
  • INTEGER_GREATER_THAN -> FdpTagIntegerGreaterThan
  • INTEGER_GREATER_THAN_OR_EQUAL -> FdpTagIntegerGreaterThanOrEqual
  • DOUBLE_EXISTS -> FdpTagDoubleExists
  • 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_EXISTS
  • DOUBLE_GREATER_THAN
  • DOUBLE_GREATER_THAN_OR_EQUAL
  • DOUBLE_LESS_THAN
  • DOUBLE_LESS_THAN_OR_EQUAL
  • INTEGER_EQUALS
  • INTEGER_EXISTS
  • 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_EXISTS
  • STRING_STARTS_WITH

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.

json
{ "id": "FDP_9", "name": "shipping", "description": "for requests from shipping module", "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

CodeTypeDescription
201EntityShortRepresentation

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

204-

Success. The failure detection parameter set has been updated. Response doesn't have a body.

400ErrorEnvelope

Failed. The input is invalid.

Response body objects

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

ElementTypeDescription
idstring

The ID of the Dynatrace entity.

namestring

The name of the Dynatrace entity.

Can be null.

descriptionstring

A short description of the Dynatrace entity.

Can be null.

Response body JSON model

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

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.

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

Authentication

To execute this request, you need an access token with Write configuration (WriteConfig) scope. To learn how to obtain and use it, see Tokens and authentication.

Response

Response codes

CodeTypeDescription
204-

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

400ErrorEnvelope

Failed. The input is invalid.