Settings API - HTTP failure detection parameters schema table

HTTP failure detection parameters (builtin:failure-detection.service.http-parameters)

Dynatrace failure detection automatically detects the vast majority of error conditions in your environment. However, detected service errors don't necessarily mean that the underlying requests have failed. There may be cases where the default service failure detection settings don't meet your particular needs. In such cases, you can configure the settings provided below. Please note that these settings are not applicable to services of type 'Span service'. For complete details, see configure service failure detection.

Schema ID
Schema groups
Scope
builtin:failure-detection.service.http-parameters
  • group:failure-detection
SERVICE - Service
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:failure-detection.service.http-parameters
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:failure-detection.service.http-parameters
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:failure-detection.service.http-parameters

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

Property
Type
Description
Required
Override global failure detection settings
enabled
boolean
-
required
HTTP response codes
httpResponseCodes
-
required
HTTP 404 (broken links)
brokenLinks

HTTP 404 response codes are thrown when a web server can't find a certain page. 404s are classified as broken links on the client side and therefore aren't considered to be service failures. By enabling this setting, you can have 404s treated as server-side service failures.

required
The httpResponseCodes object
Property
Type
Description
Required
HTTP response codes which indicate an error on the server side
serverSideErrors
text
-
required
Treat missing HTTP response code as server side errors
failOnMissingResponseCodeServerSide
boolean
-
required
HTTP response codes which indicate client side errors
clientSideErrors
text
-
required
Treat missing HTTP response code as client side error
failOnMissingResponseCodeClientSide
boolean
-
required