Frequent issue detection API - PUT configuration

This API is deprecated. Use the Settings API instead. Look for the Frequent issue detection (builtin:anomaly-detection.frequent-issues) schema.

Updates the configuration of frequent issue detection.

The request consumes an application/json payload.

PUTSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/frequentIssueDetection
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/frequentIssueDetection

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
body

The JSON body of the request, containing parameters of the frequent issue detection configuration

body
optional

Request body objects

The FrequentIssueDetectionConfig object

Parameters of the frequent issue detection. To learn more about it, see Detection of frequent issues in Dynatrace Documentation.

Element
Type
Description
Required
frequentIssueDetectionApplicationEnabled
boolean

The detection for applications is enabled (true) or disabled (false).

required
frequentIssueDetectionInfrastructureEnabled
boolean

The detection for infrastructure is enabled (true) or disabled (false).

required
frequentIssueDetectionServiceEnabled
boolean

The detection for services is enabled (true) or disabled (false).

required
metadata

Metadata useful for debugging

optional

The ConfigurationMetadata object

Metadata useful for debugging

Element
Type
Description
Required
clusterVersion
string

Dynatrace version.

optional
configurationVersions
integer[]

A sorted list of the version numbers of the configuration.

optional
currentConfigurationVersions
string[]

A sorted list of version numbers of the configuration.

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.

{
  "frequentIssueDetectionApplicationEnabled": true,
  "frequentIssueDetectionInfrastructureEnabled": true,
  "frequentIssueDetectionServiceEnabled": true
}

Response

Response codes

Code
Type
Description
204
-

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

400

Failed. The input is invalid

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

The request consumes an application/json payload.

POSTSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/frequentIssueDetection/validator
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/frequentIssueDetection/validator

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.

Response

Response codes

Code
Type
Description
204
-

Validated. The submitted configuration is valid. Response doesn't have a body.

400

Failed. The input is invalid

Example

In this example, the request updates the configuration of anomaly detection for applications from the GET request example. It activates frequent issue detection for applications.

The API token is passed in the Authorization header.

You can download or copy the example request body to try it out on your own. Be sure to create a backup copy of your current configuration with the GET request.

Curl

curl -L -X PUT 'https://mySampleEnv.live.dynatrace.com/api/config/v1/frequentIssueDetection' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
--data-raw '{
    "frequentIssueDetectionApplicationEnabled": true,
    "frequentIssueDetectionServiceEnabled": true,
    "frequentIssueDetectionInfrastructureEnabled": false
}'

Request URL

https://mySampleEnv.live.dynatrace.com/api/config/v1/frequentIssueDetection

Request body

{
  "frequentIssueDetectionApplicationEnabled": true,
  "frequentIssueDetectionServiceEnabled": true,
  "frequentIssueDetectionInfrastructureEnabled": false
}

Response code

204

Result

The updated configuration has the following parameters:

Anomaly detection configuration - updated

Related topics