Request URL

Device can be created using two methods:

PUT https://api.dotcom-monitor.com/config_api_v1/devices
POST  https://api.dotcom-monitor.com/config_api_v1/devices?verb=PUT

 Header Parameters

Content-Type: application/json
Example Post body
{
    "Avoid_Simultaneous_Checks": false,
    "Alert_Silence_Min": -2815394,
    "False_Positive_Check": false,
    "Locations": [
        1,
        4,
        6,
        14,
        15,
        17,
        19,
        23,
        43,
        71,
        73
    ],
    "Frequency": 10800,
    "Filter_Id": 7791,
    "Platform_Id": 1,
    "Name": "new device"
}

Required Body Parameters

To specify a JSON object parameters for a new device, we recommend you get an existed device info first and use the response as a sample for a new device object. Find the description of common fields in the API: Device Methods Overview.

The following fields are required in the request body:

Field

Type

Required/Optional

 Description

Locations

array of int32

required

*Except MetricsView devices

 An array containing location IDs assigned to a specified device. At least one location must be specified in the requests.

Example:
"Locations": [1, 2, 4, 5, 8]

Frequency

int32

required

 This Field reflects monitoring frequency in seconds.

Example:
"Frequency": 10800

Platform_Id

int32

required

All devices are distributed by 5 platforms. Each platform has its own “Platform_Id”.

Potential values for Platform_Id:
Platform name Platform_Id
BrowserView 7
MetricsView 3
ServerView 1
WebView 12
IMPORTANT: UserView is not supported by dotcom-monitor API v.1. Userview scripts can be created/recorded only using EveryStep Scripting Tool.
Example:
"Id": 7

Name

string

optional

 It is recommended to specify a unique name for the device.

Example:
"Name": "new name"
When you set up a new device and do not assign any filter, the default filter is automatically assigned to the device.

Success Response

Example response
{
    "Success":true,
    "Result":8666
}
Field

Type

 Description

Result

int32

 The unique id for the device.