Failure detection API - GET a parameter set

Gets the specified failure detection parameter set.

The request produces an application/json payload.

Early Adopter

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

GET
  • Managed 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 the Read configuration (ReadConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter Type Description In Required
id string

The ID of the required failure detection parameter set.

path required

Response

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

Response codes

Code Description
200

Success

404

Failed. The specified entity doesn't exist.

Response body

The FailureDetectionParameterSet object

A set of failure detection parameters (FDP).

These parameters define the conditions of failure and success.

Element Type Description
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.

name string

The display name of the FDP set.

The length of the name is limited to 150 characters.

description string

A short description of the FDP set.

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.

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.

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.

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.

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.

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.

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.

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.

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.

tagConditions FdpTagCondition[]

A list of tag-based conditions.

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

The FdpTagCondition object

Configuration of the tag condition in the FDP set.

Element Type Description
tagKey string

The key of the tag to be checked.

predicate FdpTagPredicate

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
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 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
classPattern string
messagePattern string