Synthetic monitors API - POST a monitor

Creates a new synthetic monitor.

Parameters

To find all model variations that depend on the type of the model, see JSON models.

jsoncopydownload
{
  "anomalyDetection": {
    "loadingTimeThresholds": {
      "enabled": true,
      "thresholds": [
        {
          "requestIndex": 1,
          "type": "TOTAL",
          "valueMs": 100
        }
      ]
    },
    "outageHandling": {
      "globalOutage": true,
      "localOutage": true,
      "localOutagePolicy": {
        "affectedLocations": 1,
        "consecutiveRuns": 3
      }
    }
  },
  "enabled": true,
  "events": [],
  "frequencyMin": 5,
  "keyPerformanceMetrics": {
    "loadActionKpm": "VISUALLY_COMPLETE",
    "xhrActionKpm": "VISUALLY_COMPLETE"
  },
  "locations": [
    "GEOLOCATION-9999453BE4BDB3CD"
  ],
  "manuallyAssignedApps": [
    "APPLICATION-4ADF0EF407C7C545"
  ],
  "name": "Browser Monitor Example",
  "script": {
    "configuration": {
      "device": {
        "deviceName": "Desktop",
        "orientation": "landscape"
      }
    },
    "events": [
      {
        "description": "Loading of \"example.com\"",
        "type": "navigate",
        "url": "http://example.com",
        "wait": {
          "waitFor": "page_complete"
        }
      }
    ],
    "type": "availability",
    "version": "1.0"
  },
  "tags": [
    "example"
  ],
  "type": "BROWSER"
}

Response

jsoncopydownload
{
  "entityId": "string"
}

Example

In this example, the request creates a simple browser monitor that navigates to dynatrace.com.

The monitor is executed every 10 minutes from one location, which has the ID of GEOLOCATION-0A41430434C388A9. A problem will be raised if the website is unavailable for three consecutive runs. A notification is sent if the website takes longer than 500 milliseconds to load.

The API token is passed in the Authorization header.

The response contains the entity ID of the newly created monitor.

Since the request body is lengthy, it is truncated in this example Curl section. See the full body in the Request body section. You can download or copy the example request body to try it out on your own. Before using it, make sure that the location from the example is available in your environment. You can fetch the list of available locations with the GET all synthetic locations call. If the location is not available, replace it with any location you're using.

Curl

bashcopydownload
curl -X POST \
  https://mySampleEnv.live.dynatrace.com/api/v1/synthetic/monitors \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
  -H 'Content-Type: application/json' \
  -d '{<truncated - see the Request body section >}'

Request URL

plaintextcopydownload
https://mySampleEnv.live.dynatrace.com/api/v1/synthetic/monitors

Request body

jsoncopydownload
{
  "frequencyMin": 10,
  "anomalyDetection": {
    "outageHandling": {
      "globalOutage": true,
      "localOutage": false,
      "localOutagePolicy": {
        "affectedLocations": 1,
        "consecutiveRuns": 3
      }
    },
    "loadingTimeThresholds": {
      "enabled": true,
      "thresholds": [
        {
          "type": "total",
          "valueMs": 500
        }
      ]
    }
  },
  "type": "BROWSER",
  "name": "restExample",
  "locations": ["GEOLOCATION-0A41430434C388A9"],
  "enabled": true,
  "script": {
    "configuration": {
      "device": {
        "orientation": "landscape",
        "deviceName": "Desktop"
      }
    },
    "type": "clickpath",
    "version": "1.0",
    "events": [
      {
        "type": "navigate",
        "wait": {
          "waitFor": "page_complete"
        },
        "description": "navigate to main page ",
        "url": "https://www.dynatrace.com"
      }
    ]
  },
  "tags": ["restExample"]
}

Response body

jsoncopydownload
{
  "entityId": "SYNTHETIC_TEST-00000000000254E2"
}

Response code

200