Web application configuration API - GET error rules

Get the configuration of error rules in the specified application.

The request produces an application/json payload.

GET	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/config/v1/applications/web/{id}/errorRules`
GET	Environment ActiveGate	`https://{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

Parameter	Type	Description	In	Required
id	string	The ID of the required web application.	path	required

Response

Response codes

Code	Type	Description
200	ApplicationErrorRules	Success

Response body objects

The `ApplicationErrorRules` object

Configuration of error rules in the web application.

Element	Type	Description
customErrorRules	CustomErrorRule[]	An ordered list of custom errors. Rules are evaluated from top to bottom; the first matching rule applies.
httpErrorRules	HttpErrorRule[]	An ordered list of HTTP errors. Rules are evaluated from top to bottom; the first matching rule applies.
ignoreCustomErrorsInApdexCalculation	boolean	Exclude (`true`) or include (`false`) custom errors listed in customErrorRules in Apdex calculation.
ignoreHttpErrorsInApdexCalculation	boolean	Exclude (`true`) or include (`false`) HTTP errors listed in httpErrorRules in Apdex calculation.
ignoreJavaScriptErrorsInApdexCalculation	boolean	Exclude (`true`) or include (`false`) JavaScript errors in Apdex calculation.

The `CustomErrorRule` object

Configuration of the custom error in the web application.

Element	Type	Description
capture	boolean	Capture (`true`) or ignore (`false`) the error.
customAlerting	boolean	Include (`true`) or exclude (`false`) the error in Davis AI problem detection and analysis.
impactApdex	boolean	Include (`true`) or exclude (`false`) the error in Apdex calculation.
keyMatcher	string	The matching operation for the keyPattern. `BEGINS_WITH` `CONTAINS` `ENDS_WITH` `EQUALS`
keyPattern	string	The key of the error to look for.
valueMatcher	string	The matching operation for the valuePattern. `BEGINS_WITH` `CONTAINS` `ENDS_WITH` `EQUALS`
valuePattern	string	The value of the error to look for.

The `HttpErrorRule` object

Configuration of the HTTP error in the web application.

Element	Type	Description
capture	boolean	Capture (`true`) or ignore (`false`) the error.
considerBlockedRequests	boolean	If `true`, match by errors that have CSP Rule violations.
considerForAi	boolean	Include (`true`) or exclude (`false`) the error in Davis AI problem detection and analysis.
considerUnknownErrorCode	boolean	If `true`, match by errors that have unknown HTTP status code.
errorCodes	string	The HTTP status code or status code range to match by. This field is required if considerUnknownErrorCode AND considerBlockedRequests are both set to `false`.
filter	string	The matching rule for the URL. `BEGINS_WITH` `CONTAINS` `ENDS_WITH` `EQUALS`
filterByUrl	boolean	If `true`, filter errors by URL.
impactApdex	boolean	Include (`true`) or exclude (`false`) the error in Apdex calculation.
url	string	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
}