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 | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/config/v1/applications/web/{id}/errorRules |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/applications/web/{id}/errorRules | |
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 ( |
ignoreHttpErrorsInApdexCalculation | boolean | Exclude ( |
ignoreJavaScriptErrorsInApdexCalculation | boolean | Exclude ( |
The CustomErrorRule
object
Configuration of the custom error in the web application.
Element | Type | Description |
---|---|---|
capture | boolean | Capture ( |
customAlerting | boolean | Include ( |
impactApdex | boolean | Include ( |
keyMatcher | string | The matching operation for the keyPattern.
|
keyPattern | string | The key of the error to look for. |
valueMatcher | string | The matching operation for the valuePattern.
|
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 ( |
considerBlockedRequests | boolean | If |
considerForAi | boolean | Include ( |
considerUnknownErrorCode | boolean | If |
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 |
filter | string | The matching rule for the URL.
|
filterByUrl | boolean | If |
impactApdex | boolean | Include ( |
url | string | The URL to look for. |
Response body JSON model
1{2 "customErrorRules": [3 {4 "capture": true,5 "customAlerting": true,6 "impactApdex": true,7 "keyMatcher": "BEGINS_WITH",8 "keyPattern": "string",9 "valueMatcher": "BEGINS_WITH",10 "valuePattern": "string"11 }12 ],13 "httpErrorRules": [14 {15 "capture": true,16 "considerBlockedRequests": true,17 "considerForAi": true,18 "considerUnknownErrorCode": true,19 "errorCodes": "400",20 "filter": "BEGINS_WITH",21 "filterByUrl": true,22 "impactApdex": true,23 "url": "string"24 }25 ],26 "ignoreCustomErrorsInApdexCalculation": true,27 "ignoreHttpErrorsInApdexCalculation": true,28 "ignoreJavaScriptErrorsInApdexCalculation": true29}