Synthetic monitors API - POST a monitor
Creates a new synthetic monitor.
The configuration of the new monitor is passed via its JSON script.
POST |
|
Authentication
To execute this request, you need the Create and read synthetic monitors, locations, and nodes (ExternalSyntheticIntegration
) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.
Parameters
To find all model variations that depend on the type of the model, see JSON models.
Parameter | Type | Description | In | Required |
---|---|---|---|---|
body | SyntheticMonitorUpdate |
The JSON body of the request, containing parameters of the new synthetic monitor. |
body | optional |
Body format
The SyntheticMonitorUpdate object
The synthetic monitor update. This is a base object, the exact type depends on the value of the type
field.
Element | Type | Description | Required |
---|---|---|---|
frequencyMin | integer |
The frequency of the monitor, in minutes. You can use one of the following values: |
required |
anomalyDetection | AnomalyDetection | optional | |
type | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
name | string |
The name of the monitor. |
required |
locations | string[] |
A list of locations from which the monitor is executed. To specify a location, use its entity ID. |
required |
enabled | boolean |
The monitor is enabled ( |
required |
script | object |
The script of a browser or HTTP monitor. |
required |
tags | TagWithSourceInfo[] |
A set of tags assigned to the monitor. You can specify only the value of the tag here and the |
required |
manuallyAssignedApps | string[] |
A set of manually assigned applications. |
required |
The TagWithSourceInfo object
Tag with source of a Dynatrace entity.
Element | Type | Description | Required |
---|---|---|---|
source | string |
The source of the tag, such as USER, RULE_BASED or AUTO |
optional |
context | string |
The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the |
required |
key | string |
The key of the tag. Custom tags have the tag value here. |
required |
value | string |
The value of the tag. Not applicable to custom tags. |
optional |
The AnomalyDetection object
The anomaly detection configuration.
Element | Type | Description | Required |
---|---|---|---|
outageHandling | OutageHandlingPolicy | optional | |
loadingTimeThresholds | LoadingTimeThresholdsPolicyDto | optional |
The LoadingTimeThresholdsPolicyDto object
Performance thresholds configuration.
Element | Type | Description | Required |
---|---|---|---|
enabled | boolean |
Performance threshold is enabled ( |
required |
thresholds | LoadingTimeThreshold[] |
The list of performance threshold rules. |
optional |
The LoadingTimeThreshold object
The performance threshold rule.
Element | Type | Description | Required |
---|---|---|---|
type | string |
The type of the threshold: total loading time or action loading time. |
required |
valueMs | integer |
Notify if monitor takes longer than X milliseconds to load. |
required |
requestIndex | integer |
Specify the request to which an ACTION threshold applies. |
optional |
eventIndex | integer |
Specify the event to which an ACTION threshold applies. |
optional |
The OutageHandlingPolicy object
Outage handling configuration.
Element | Type | Description | Required |
---|---|---|---|
globalOutage | boolean |
When enabled ( |
required |
localOutage | boolean |
When enabled ( |
required |
localOutagePolicy | LocalOutagePolicy | required | |
retryOnError | boolean |
Schedule retry if browser monitor execution results in a fail. For HTTP monitors this property is ignored. |
optional |
The LocalOutagePolicy object
Local outage handling configuration.
Alert if affectedLocations of locations are unable to access the web application consecutiveRuns times consecutively.
Element | Type | Description | Required |
---|---|---|---|
affectedLocations | integer |
The number of affected locations to trigger an alert. |
required |
consecutiveRuns | integer |
The number of consecutive fails to trigger an alert. |
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.
{
"frequencyMin": 5,
"anomalyDetection": {
"outageHandling": {
"globalOutage": true,
"localOutage": true,
"localOutagePolicy": {
"affectedLocations": 1,
"consecutiveRuns": 3
}
},
"loadingTimeThresholds": {
"enabled": true,
"thresholds": [
{
"type": "TOTAL",
"valueMs": 100,
"requestIndex": 1
}
]
},
"_inheritance": "SyntheticMonitorUpdate"
},
"type": "BROWSER",
"name": "Browser Monitor Example",
"locations": [
"GEOLOCATION-9999453BE4BDB3CD"
],
"enabled": true,
"script": {
"type": "availability",
"version": "1.0",
"configuration": {
"device": {
"deviceName": "Desktop",
"orientation": "landscape"
}
},
"events": [
{
"type": "navigate",
"description": "Loading of "example.com"\n",
"url": "http://example.com",
"wait": {
"waitFor": "page_complete"
}
}
],
"_inheritance": "SyntheticMonitorUpdate"
},
"keyPerformanceMetrics": {
"loadActionKpm": "VISUALLY_COMPLETE",
"xhrActionKpm": "VISUALLY_COMPLETE",
"_inheritance": "SyntheticMonitorUpdate"
},
"tags": [
"example"
],
"manuallyAssignedApps": [
"APPLICATION-4ADF0EF407C7C545"
],
"events": []
}
Response
Response codes
Code | Description |
---|---|
200 | Success. The new synthetic monitor has been created. The response contains the Dynatrace entity ID of the new monitor. |
Response body
The EntityIdDto object
A DTO for entity ID.
Element | Type | Description |
---|---|---|
entityId | string | Entity ID to be transferred |
{
"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
curl -X POST \
https://mySampleEnv.live.dynatrace.com/api/v1/synthetic/monitors \
-H 'Authorization: Api-Token abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
-d '{<truncated - see the Request body section >}'
Request URL
https://mySampleEnv.live.dynatrace.com/api/v1/synthetic/monitors
Request body
{
"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
{
"entityId": "SYNTHETIC_TEST-00000000000254E2"
}
Response code
200