Request URL

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

Pauses monitoring of the device (e.g., during a maintenance window) for a specified time period on a given date and time.

To postpone monitoring of the device until enabled manually, use the Postpone parameter in the device edit request.

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.

Header Parameters

Content-Type: application/json
Example Post body of the request that will postpone monitoring for 10 minutes from the moment of the request
{ 
  "Postpone_Min": 10, 
 }
Example Post body of the request that will postpone monitoring for 10 minutes on the specified date and time
{ 
  "Postpone_Min": 10, 
  "Date_From": "14-May-2023 12:30" 
}

Body Parameters

Field Type Required Description
Postpone_min

int

true

Defines the time period in minutes for which monitoring will be paused from the moment of the request.

Example 1:

{ 
"Postpone_Min": 10 
}

Will postpone (set maintenance) for 10 minutes, at the moment of the request.

Example 2. Unpostpone monitoring:

{ 
"Postpone_Min": 0 
}

Will enable monitoring for a postponed device immediately at the moment of the request.

Date_From

string

optional

Timestamp reflecting the moment when the device will be postponed.

Example:

{
 "Postpone_Min": 10,
 "Date_From": "14-May-2023 12:30"
}

Will postpone (set maintenance) for 10 minutes on the specified date and time. Time is set based on a user’s time zone (server-side autoconvert).

Success Response

Example response
{

"Success": true,

"Result": "Timed postpone for device 7394 has been set to 10"

}