Disk events anomaly detection API - POST an event

Creates a new disk event rule.

The request consumes and produces an application/json payload.

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

Body format

      {
  "metadata": {
    "configurationVersions": [
      4,
      2
    ],
    "currentConfigurationVersions": [
      "1.0.4",
      "1.23"
    ],
    "clusterVersion": "1.192.1"
  },
  "id": "string",
  "name": "string",
  "enabled": true,
  "metric": "LOW_DISK_SPACE",
  "threshold": 1,
  "samples": 10,
  "violatingSamples": 8,
  "diskNameFilter": {
    "operator": "CONTAINS",
    "value": "string"
  },
  "tagFilters": [
    {
      "context": "AWS",
      "key": "string",
      "value": "string"
    }
  ],
  "hostGroupId": "string"
}
    

Response

Response codes

Response body

    {
  "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
  "name": "Dynatrace entity",
  "description": "Dynatrace entity for the REST API example\n"
}
  

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.

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.

Response

Response codes

Response body

A successful request doesn't return any content.

Example

In this example, the request creates a new custom disk event rule named very slow disk. The rule triggers an alert for any disk whose name starts with C and whose read time exceeds 200 milliseconds in 8 out of 10 samples.

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.

Curl

curl -X POST \
  https://mySampleEnv.live.dynatrace.com/api/config/v1/anomalyDetection/diskEvents \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \  
  -H 'Content-Type: application/json' \
  -d '{
  "name": "very slow disk",
  "enabled": true,
  "metric": "READ_TIME_EXCEEDING",
  "threshold": 200,
  "samples": 10,
  "violatingSamples": 8,
  "diskNameFilter": {
    "operator": "STARTS_WITH",
    "value": "C"
  },
  "tagFilters": []
}
'

Request URL

https://mySampleEnv.live.dynatrace.com/api/config/v1/anomalyDetection/diskEvents

Request body

{
  "name": "very slow disk",
  "enabled": true,
  "metric": "READ_TIME_EXCEEDING",
  "threshold": 200,
  "samples": 10,
  "violatingSamples": 8,
  "diskNameFilter": {
    "operator": "STARTS_WITH",
    "value": "C"
  },
  "tagFilters": []
}

Response body

{
  "id": "fdd83212-9c08-44ba-a0cf-dbb471cd819a",
  "name": "very slow disk"
}

Response code

204

Result

The new rule looks like this in the UI: