Web application configuration API - GET error rules

  • Reference
  • Published Sep 24, 2020

Get the configuration of error rules in the specified application.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/applications/web/{id}/errorRules
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/applications/web/{id}/errorRules

Authentication

To execute this request, you need an access token with ReadConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
idstring

The ID of the required web application.

pathrequired

Response

Response codes

CodeTypeDescription
200ApplicationErrorRules

Success

Response body objects

The ApplicationErrorRules object

Configuration of error rules in the web application.

ElementTypeDescription
customErrorRulesCustomErrorRule[]

An ordered list of custom errors.

Rules are evaluated from top to bottom; the first matching rule applies.

httpErrorRulesHttpErrorRule[]

An ordered list of HTTP errors.

Rules are evaluated from top to bottom; the first matching rule applies.

ignoreCustomErrorsInApdexCalculationboolean

Exclude (true) or include (false) custom errors listed in customErrorRules in Apdex calculation.

ignoreHttpErrorsInApdexCalculationboolean

Exclude (true) or include (false) HTTP errors listed in httpErrorRules in Apdex calculation.

ignoreJavaScriptErrorsInApdexCalculationboolean

Exclude (true) or include (false) JavaScript errors in Apdex calculation.

The CustomErrorRule object

Configuration of the custom error in the web application.

ElementTypeDescription
captureboolean

Capture (true) or ignore (false) the error.

customAlertingboolean

Include (true) or exclude (false) the error in Davis AI problem detection and analysis.

impactApdexboolean

Include (true) or exclude (false) the error in Apdex calculation.

keyMatcherstring

The matching operation for the keyPattern.

  • BEGINS_WITH
  • CONTAINS
  • ENDS_WITH
  • EQUALS
keyPatternstring

The key of the error to look for.

valueMatcherstring

The matching operation for the valuePattern.

  • BEGINS_WITH
  • CONTAINS
  • ENDS_WITH
  • EQUALS
valuePatternstring

The value of the error to look for.

The HttpErrorRule object

Configuration of the HTTP error in the web application.

ElementTypeDescription
captureboolean

Capture (true) or ignore (false) the error.

considerBlockedRequestsboolean

If true, match by errors that have CSP Rule violations.

considerForAiboolean

Include (true) or exclude (false) the error in Davis AI problem detection and analysis.

considerUnknownErrorCodeboolean

If true, match by errors that have unknown HTTP status code.

errorCodesstring

The HTTP status code or status code range to match by.

This field is required if considerUnknownErrorCode AND considerBlockedRequests are both set to false.

filterstring

The matching rule for the URL.

  • BEGINS_WITH
  • CONTAINS
  • ENDS_WITH
  • EQUALS
filterByUrlboolean

If true, filter errors by URL.

impactApdexboolean

Include (true) or exclude (false) the error in Apdex calculation.

urlstring

The URL to look for.

Response body JSON model

{
  "customErrorRules": [
    {
      "capture": true,
      "customAlerting": true,
      "impactApdex": true,
      "keyMatcher": "BEGINS_WITH",
      "keyPattern": "string",
      "valueMatcher": "BEGINS_WITH",
      "valuePattern": "string"
    }
  ],
  "httpErrorRules": [
    {
      "capture": true,
      "considerBlockedRequests": true,
      "considerForAi": true,
      "considerUnknownErrorCode": true,
      "errorCodes": "400",
      "filter": "BEGINS_WITH",
      "filterByUrl": true,
      "impactApdex": true,
      "url": "string"
    }
  ],
  "ignoreCustomErrorsInApdexCalculation": true,
  "ignoreHttpErrorsInApdexCalculation": true,
  "ignoreJavaScriptErrorsInApdexCalculation": true
}