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
  • Managed 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

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 (true) or include (false) JavaScript errors in Apdex calculation.

required
ignoreHttpErrorsInApdexCalculation boolean

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

required
ignoreCustomErrorsInApdexCalculation boolean

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

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 (true) or ignore (false) the error.

required
impactApdex boolean

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

required
customAlerting boolean

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

required

The HttpErrorRule object

Configuration of the HTTP error in the web application.

Element Type Description Required
considerUnknownErrorCode boolean

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

required
considerBlockedRequests boolean

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

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

optional
filterByUrl boolean

If true, filter errors by URL.

required
filter string

The matching rule for the URL.

optional
url string

The URL to look for.

optional
capture boolean

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

required
impactApdex boolean

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

required
considerForAi boolean

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

required

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.