• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • HTTP failure detection parameters

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. For complete details, see configure service failure detection.

Schema IDSchema groupsScope
builtin:failure-detection.service.http-parameters
  • group:failure-detection
SERVICE - Service
Retrieve schema via Settings API
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

PropertyLabelTypeDescriptionRequired
enabledOverride global failure detection settingsboolean-required
httpResponseCodesHTTP response codeshttpResponseCodes-required
brokenLinksHTTP 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

Request body objects

The brokenLinks object
PropertyLabelTypeDescriptionRequired
http404NotFoundFailuresConsider 404 HTTP response codes as failuresboolean-required
brokenLinkDomainsRules for broken links to related domainsset

If your application relies on other hosts at other domains, add the associated domain names here. Once configured, Dynatrace will consider 404s thrown by hosts at these domains to be service failures related to your application.

required
The httpResponseCodes object
PropertyLabelTypeDescriptionRequired
serverSideErrorsHTTP response codes which indicate an error on the server sidetext-required
failOnMissingResponseCodeServerSideTreat missing HTTP response code as server side errorsboolean-required
clientSideErrorsHTTP response codes which indicate client side errorstext-required
failOnMissingResponseCodeClientSideTreat missing HTTP response code as client side errorboolean-required