Request URL

GET https://api.dotcom-monitor.com/config_api_v1/device/{device_id}

Get device setting by its id.

Path Parameters

Field Type Required Description
device_id

string

true

 The unique id of a monitoring device. To request a list of devices’ IDs within a platform see API: Get Device List by Platform.

To see a device id from within your dotcom-monitor account, open the target device in the Device Manager list to edit. In the browser’s address bar you’ll see something like:

https://user.dotcom-monitor.com/ClientID/DeviceEdit?pid=dc7f4ff2ca944dekjh1078b96707002&deviceId=63698&taskId=132834

The deviceId=63698 is the device ID.

Success Response

Example ServerView/BrowserView Device JSON Object 
{
    "Avoid_Simultaneous_Checks": false,
    "Alert_Silence_Min": 94,
    "False_Positive_Check": false,
    "Locations": [
        1,
        4,
        6,
        14,
        15,
        17,
        19,
        23,
        43,
        71,
        73
    ],
    "Tags": null,
    "ContextParams": [],
    "Send_Uptime_Alert": false,
    "Status_Description": "POSTPONED",
    "Postpone": true,
    "Owner_Device_Id": 0,
    "Frequency": 10800,
    "Filter_Id": 7791,
    "Scheduler_Id": 0,
    "Notifications": {
        "E_Mail_Flag": false,
        "E_Mail_Address": null,
        "E_Mail_TimeInterval_Min": 0,
        "WL_Device_Flag": false,
        "WL_Device_Email_Address": null,
        "WL_Device_TimeInterval_Min": 0,
        "Pager_Flag": false,
        "Pager_Area_Code": null,
        "Pager_Phone": null,
        "Pager_Num_Code": null,
        "Pager_TimeInterval_Min": 0,
        "Phone_Flag": false,
        "Phone_Area_Code": null,
        "Phone_Phone": null,
        "Phone_TimeInterval_Min": 0,
        "SMS_Flag": false,
        "SMS_Phone": null,
        "SMS_TimeInterval_Min": 0,
        "Script_Flag": false,
        "Script_Batch_File_Name": null,
        "Script_TimeInterval_Min": 0,
        "SNMP_TimeInterval_Min": 0,
        "Teams_TimeInterval_Min": 0,
        "Slack_TimeInterval_Min": 0,
        "AlertOps_TimeInterval_Min": 0,
        "PagerDuty_TimeInterval_Min": 0,
        "Notification_Groups": []
    },
    "Id": 47432,
    "Number_Of_Tasks": 1,
    "WaitingForApproval": false,
    "Platform_Id": 1,
    "Package_Id": 52,
    "Name": "FullPageDomain.cs"
}

Fields Description

Use these fields to specify information about a Device in your API requests.

Field

Type

 Description

Avoid_Simultaneous_Checks

boolean

 Indicates if simultaneous check from the multiple monitoring locations is allowed. Available only for ServerView devices.

Example:
"Avoid_Simultaneous_Checks": true

Alert_Silence_Min

int32

 READ ONLY. Defines time period in minutes when all alerts are disable. To disable alerts, use API: Disable Alerts for Device or API: Disable Alerts for Several Devices.

Example:
"Alert_Silence_Min": 46

False_Positive_Check

boolean

 When error detected we run series of checks to ensure it is not a false alert. Those checks may take some time, depending on the error type and number of tasks in the device. This may cause some delay in downtime alert. You can disable (“true” state) false positive check to ensure immediate downtime alert, but it may result in some “false” alerts. We recommend  NOT to disable “False positive check”.

Example:
"False_Positive_Check": false

Locations

array of int32

 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]

Tags

array of string

 An array containing names of the tags assigned to a specified device.

Example:
"Tags": ["green", "red", "black"]

Send_Uptime_Alert

boolean

 When this option is enabled, you will receive an alert when all detected errors are resolved.

Example:
"Send_Uptime_Alert": false

Status_Description

string

 READ ONLY. Describing current device state.

Example:
"Status_Description": "POSTPONED"

Postpone

boolean

 Monitoring can be set on a pause by postponing a device.

Example:
"Postpone": true,

Owner_Device_Id

int32

 This field reflects Owner Device ID.

Example:
"Owner_Device_Id": 8534

Frequency

int32

 This field reflects monitoring frequency in seconds.

Example:
"Frequency": 10800

Filter_Id

int32

 This field reflects Filter ID assigned to a device.

Example:
"Filter_Id": 853

Scheduler_Id

int32

 This field reflects Scheduler ID assigned to a device.

Example:
"Scheduler_Id": 534

Notifications

array of objects

 Indicates list of alert settings

Example #1:
"Notifications":
      {
      "E_Mail_Flag": true,
      "E_Mail_Address": "demo@at.com",
      "E_Mail_TimeInterval_Min": 10
      }
Example #2:
"Notifications":
      {
      "Notification_Groups":
            [{
                  "Id": 608,
                  "Time_Shift_Min": 10
            }]
      }

E_Mail_Flag

boolean

 Defines if e-mail alert will be sent.

Example:
"E_Mail_Flag": false

E_Mail_Address

string

 Specifies an email address for an email alerts.

Example:
"E_Mail_Address": "demo@company.com"

E_Mail_TimeInterval_Min

int32

 This field allows to set an interval between email alerts in minutes

Example:
"E_Mail_TimeInterval_Min": 15

WL_Device_Flag

boolean

 Defines if wireless device alert will be sent.

Example:
"WL_Device_Flag": false

WL_Device_Email_Address

string

 This field specifies a wireless device, such as phone or pager, for alerts.

Example:
"WL_Device_Email_Address": "wireless@company.com"

WL_Device_TimeInterval_Min

int32

 This field allows to set an interval between wireless device alerts in minutes.

Example:
"WL_Device_TimeInterval_Min": 13

Pager_Flag

boolean

 Defines if pager alerts will be sent.

Example:
"Pager_Flag": true

Pager_Area_Code

string

 Pager area code.

Example:
"Pager_Area_Code": "917"

Pager_Phone

string

 Pager Phone.

Example:
"Pager_Phone": "3214564"

Pager_Num_Code

string

 Code for a numeric pagers.

Example:
"Pager_Num_Code": "225"

Pager_TimeInterval_Min

int32

 This field allows setting an interval between pager alerts in minutes.

Example:
"Pager_TimeInterval_Min": 5

Phone_Flag

boolean

 Defines if phone call alerts will take place. To receive alerts via phone set value to “true” and specify phone number. Phone alerts are interactive, allowing you to postpone subsequent alerts once an alert in received.

Example:
"Phone_Flag": true

Phone_Area_Code

string

 If the country code is “1” (for example, in the US, Canada, and Caribbean), enter the area code and number (for example, 952-5134349). For all other country codes, use the prefix “011”, the country code and the phone number (for example, 011-44-95-2244392).

Example:
"Phone_Area_Cde": "952"

Phone_Phone

string

 Phone number.

Example:
"Phone_Phone": "5134349"

Phone_TimeInterval_Min

int32

 This field allows setting an interval between phone calls.

Example:
"Phone_TimeInterval_Min": 2

SMS_Flag

boolean

 Defines if SMS alerts will be sent.

Example:
"SMS_Flag": false

SMS_Phone

 string A phone number with a country code (for example: US – 1 952 513 4349; UK 449524 4392). Do NOT use an international dialing prefix, such as “011” in the number.

Example:
"SMS_Phone": "19525134349"

SMS_TimeInterval_Min

int32

 This field allows setting an interval between SMS alerts.

Example:
"SMS_TimeInterval_Min": 0

Script_Flag

boolean

 This field defines if alerting will be performed by a custom alert scripts.

Example:
"Script_Flag": false

Script_Batch_File_Name

string

 Custom Script filename. Script Have to be already installed at the server.

Example:
"Script_Batch_File_Name":"alerting.cs"

Script_TimeInterval_Min

int32

 This field allows setting an interval between custom script alerts.

Example:
"Script_TimeInterval_Min":5

Notification_Groups

array of objects

 Indicates active alert groups with their ID and time shift. Time shift is an option allows you to create an Alert Escalation process that is based on the duration of the error condition, For example, First notification group could be notified immediately, Second after 10-minutes of downtime and third group after 60-minutes of downtime. Alert Escalation time intervals range from immediate to three hours.

Example:
"Notification_Groups":
      [{
            "Id": 608,
            "Time_Shift_Min": 10
      }, {
            "Id": 609,
            "Time_Shift_Min": 20
      }]

Number_Of_Tasks

int32

 READ ONLY Field.Shows number of tasks under specified device.

Example:
"Number_Of_Tasks": 15

Id

int32

 READ ONLY Field. The unique device ID. Assigned automatically  upon a new device creation. Use to specify a device in requests.

Example:
"Id": 8533

Platform_Id

int32

 READ ONLY Field. Each Platform (ServerView, UserView etc.) has its own ID. See how to get platforms’ IDs here.

Example:
"Platform_Id": 1

Name

string

 The name of the device.

Example:
"Name": "new name"