Web application configuration API - PUT error rules
Updates the configuration of error rules in the specified application.
The request consumes an application/json
payload.
PUT |
|
Authentication
To execute this request, you need the Write configuration (WriteConfig
) permission assigned to your API token. 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 |
body | ApplicationErrorRules |
The JSON body of the request. Contains the updated configuration of error rules. |
body | optional |
Body format
The ApplicationErrorRules object
Configuration of error rules in the web application.
Element | Type | Description | Required |
---|---|---|---|
ignoreJavaScriptErrorsInApdexCalculation | boolean |
Exclude ( |
required |
ignoreHttpErrorsInApdexCalculation | boolean |
Exclude ( |
required |
ignoreCustomErrorsInApdexCalculation | boolean |
Exclude ( |
required |
httpErrorRules | HttpErrorRule[] |
An ordered list of HTTP errors. Rules are evaluated from top to bottom; the first matching rule applies. |
required |
customErrorRules | CustomErrorRule[] |
An ordered list of custom errors. Rules are evaluated from top to bottom; the first matching rule applies. |
required |
The CustomErrorRule object
Configuration of the custom error in the web application.
Element | Type | Description | Required |
---|---|---|---|
keyPattern | string |
The key of the error to look for. |
required |
keyMatcher | string |
The matching operation for the keyPattern. |
required |
valuePattern | string |
The value of the error to look for. |
optional |
valueMatcher | string |
The matching operation for the valuePattern. |
optional |
capture | boolean |
Capture ( |
required |
impactApdex | boolean |
Include ( |
required |
customAlerting | boolean |
Include ( |
required |
The HttpErrorRule object
Configuration of the HTTP error in the web application.
Element | Type | Description | Required |
---|---|---|---|
considerUnknownErrorCode | boolean |
If |
required |
considerBlockedRequests | boolean |
If |
optional |
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 |
optional |
filterByUrl | boolean |
If |
required |
filter | string |
The matching rule for the URL. |
optional |
url | string |
The URL to look for. |
optional |
capture | boolean |
Capture ( |
required |
impactApdex | boolean |
Include ( |
required |
considerForAi | boolean |
Include ( |
required |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request. See the Example expandable section for working sample request.
{
"ignoreJavaScriptErrorsInApdexCalculation": true,
"ignoreHttpErrorsInApdexCalculation": true,
"ignoreCustomErrorsInApdexCalculation": true,
"httpErrorRules": [
{
"considerUnknownErrorCode": true,
"considerBlockedRequests": true,
"errorCodes": "400",
"filterByUrl": true,
"filter": "BEGINS_WITH",
"url": "string",
"capture": true,
"impactApdex": true,
"considerForAi": true
}
],
"customErrorRules": [
{
"keyPattern": "string",
"keyMatcher": "BEGINS_WITH",
"valuePattern": "string",
"valueMatcher": "BEGINS_WITH",
"capture": true,
"impactApdex": true,
"customAlerting": true
}
]
}
Response
Response codes
Code | Description |
---|---|
204 | Success. The configuration has been updated. Response doesn't have a body. |
400 | Failed. The input is invalid. |
Response body
A successful request doesn't return any content.