Web application configuration API - PUT error rules

Updates the configuration of error rules in the specified application.

The request consumes an application/json payload.

PUTSaaShttps://{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 WriteConfig 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
body

The JSON body of the request. Contains the updated configuration of error rules.

body
optional

Request body objects

The ApplicationErrorRules object

Configuration of error rules in the web application.

Element
Type
Description
Required
customErrorRules

An ordered list of custom errors.

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

required
httpErrorRules

An ordered list of HTTP errors.

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

required
ignoreCustomErrorsInApdexCalculation
boolean

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

required
ignoreHttpErrorsInApdexCalculation
boolean

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

required
ignoreJavaScriptErrorsInApdexCalculation
boolean

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

required

The CustomErrorRule object

Configuration of the custom error in the web application.

Element
Type
Description
Required
capture
boolean

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

required
customAlerting
boolean

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

required
impactApdex
boolean

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

required
keyMatcher
string

The matching operation for the keyPattern.

  • BEGINS_WITH
  • CONTAINS
  • ENDS_WITH
  • EQUALS
optional
keyPattern
string

The key of the error to look for.

optional
valueMatcher
string

The matching operation for the valuePattern.

  • BEGINS_WITH
  • CONTAINS
  • ENDS_WITH
  • EQUALS
optional
valuePattern
string

The value of the error to look for.

optional

The HttpErrorRule object

Configuration of the HTTP error in the web application.

Element
Type
Description
Required
capture
boolean

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

required
considerBlockedRequests
boolean

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

optional
considerForAi
boolean

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

required
considerUnknownErrorCode
boolean

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

required
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.

optional
filter
string

The matching rule for the URL.

  • BEGINS_WITH
  • CONTAINS
  • ENDS_WITH
  • EQUALS
optional
filterByUrl
boolean

If true, filter errors by URL.

required
impactApdex
boolean

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

required
url
string

The URL to look for.

optional

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

{
  "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
}

Response

Response codes

Code
Type
Description
204
-

Success. The configuration has been updated. Response doesn't have a body.

400

Failed. The input is invalid.

Related topics