Process groups anomaly detection API - GET configuration

Gets the configuration of anomaly detection for the specified process group.

The request produces an application/json payload.

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

Authentication

To execute this request, you need an access token with ReadConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter
Type
Description
In
Required
id
string

The Dynatrace entity ID of the required process group.

path
required

Response

Response codes

Code
Type
Description
200

Success

400

Failed. The input is invalid.

404

Process group doesn't exist

Response body objects

The AnomalyDetectionPG object

Configuration of anomaly detection for the process group.

Element
Type
Description
availabilityMonitoring

Configuration of the availability monitoring for the process group.

The AvailabilityMonitoringPG object

Configuration of the availability monitoring for the process group.

Element
Type
Description
method
string

How to monitor the availability of the process group:

  • PROCESS_IMPACT: Alert if any process of the group becomes unavailable.
  • MINIMUM_THRESHOLD: Alert if the number of active processes in the group falls below the specified threshold.
  • OFF: Availability monitoring is disabled.
  • MINIMUM_THRESHOLD
  • OFF
  • PROCESS_IMPACT
minimumThreshold
integer

Alert if the number of active processes in the group is lower than this value.

Response body JSON model

{
  "availabilityMonitoring": {
    "method": "MINIMUM_THRESHOLD",
    "minimumThreshold": 5
  }
}

Example

In this example, the request gets the configuration of anomaly detection for the process group with the ID of PROCESS_GROUP-52B42D0616D556F5.

The API token is passed in the Authorization header.

The configuration has the following settings:

GET anomaly detection config - process group

Curl

curl -L -X GET 'https://mySampleEnv.live.dynatrace.com/api/config/v1/anomalyDetection/processGroups/PROCESS_GROUP-52B42D0616D556F5' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dynatrace.com/api/config/v1/anomalyDetection/processGroups/PROCESS_GROUP-52B42D0616D556F5

Response body

{
  "availabilityMonitoring": {
    "method": "MINIMUM_THRESHOLD",
    "minimumThreshold": 10
  }
}

Response code

200

Related topics