Web application configuration API - PUT error rules

Updates the configuration of error rules in the specified application.

The request consumes an application/json payload.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

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 web application where you want to update the Application Error Rules Configuration object.	path	required
body	ApplicationErrorConfig	JSON body containing the updates to the Application Error Rules Configuration object.	body	optional

Request parameters JSON model

The ApplicationErrorConfig object

Settings for Application Error Configuration

Element	Type	Description	Required
ignoreJavaScriptErrorsInApdexCalculation	boolean	Ignore JavaScript errors in the apdex calculation	required
ignoreHttpErrorsInApdexCalculation	boolean	Ignore HTTP errors in the apdex calculation	required
ignoreCustomErrorsInApdexCalculation	boolean	Ignore custom errors in the apdex calculation	required
httpErrorRules	HttpErrorRule[]	List of HTTP errors	required
customErrorRules	CustomErrorRule[]	List of custom Errors	required

The CustomErrorRule object

Settings for Custom Error Rules

Element	Type	Description	Required
keyPattern	string	Key property	required
keyMatcher	string	Matcher rule for identifying the Key The keyMatcher element can hold these values.	required
valuePattern	string	Value property	optional
valueMatcher	string	Matcher rule for identifying the Value The valueMatcher element can hold these values.	optional
capture	boolean	Set if rule should be captured	required
impactApdex	boolean	Set if rule should be included in Apdex calculation	required
customAlerting	boolean	Set if rule should be included in custom alerting	required

The HttpErrorRule object

Settings for Http Error Rules

Element	Type	Description	Required
considerUnknownErrorCode	boolean	Set if rule should include Http Errors with an unknown error code	required
errorCodes	string	Error Codes. Mandatory if `considerUnknownErrorCode` is `false`	optional
filterByUrl	boolean	Set if rule should include the filtering by URL	required
filter	string	Matcher rule for identifying the URL The filter element can hold these values.	optional
url	string	URL to filter by if filterByUrl is switched on	optional
capture	boolean	Set if rule should be captured	required
impactApdex	boolean	Set if rule should be included in Apdex calculation	required
considerForAi	boolean	Set if rule should be included in processing for Artificial Inteligence	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,
      "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
    }
  ]
}

Possible values

Possible values for the valueMatcher element in the CustomErrorRule object:

BEGINS_WITH
CONTAINS
ENDS_WITH
EQUALS

Possible values for the keyMatcher element in the CustomErrorRule object:

BEGINS_WITH
CONTAINS
ENDS_WITH
EQUALS

BEGINS_WITH
CONTAINS
ENDS_WITH
EQUALS

Response format

A successful request doesn't return any content.

Authentication

Parameters

The ApplicationErrorConfig object

The CustomErrorRule object

The HttpErrorRule object

Possible values

Possible values for the valueMatcher element in the CustomErrorRule object:

Possible values for the keyMatcher element in the CustomErrorRule object:

Possible values for the filter element in the HttpErrorRule object:

Response format