Request URL

POST https://api.dotcom-monitor.com/config_api_v1/devices/PostponeTimed

Pauses monitoring of several devices with the provided IDs (e.g., during a maintenance window) for a specified time period on a given date and time.

Header Parameters

Content-Type: application/json
Example Post body of the request that will postpone monitoring for the listed devices
{
"SetPostpone": [
  {
   "Device_ID": 7314,
   "Postpone_Min": 20
  },
  {
   "Device_ID": 7925,
   "Postpone_Min": 10,
   "Date_From": "19-May-2023 11:33"
  },
  {
   "Device_ID": 10764,
   "Postpone_Min": 30
  },
  {
   "Device_ID": 12090,
   "Postpone_Min": 900,
   "Date_From": "19-May-2023 11:33"
  }
]
}

Body Parameters

Field Type Required Description
SetPostpone

Array of Objects

true

 Contains parameters to set timed pauses in monitoring for the group of the specified tests.
Device_ID

int32

true

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

int

true

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

Example 1:

{
   "Device_ID": 7394,
   "Postpone_Min": 20
}

Will postpone (set maintenance) for 10 minutes for the device with ID 7394.

Example 2. Unpostpone monitoring:

{ 
"Device_ID":7394
"Postpone_Min": 0 
}

Will enable monitoring for the device with ID 7394 immediately at the moment of the request.
Date_From

string

optional

 Timestamp reflecting the moment when the device will be postponed.

Example:

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

Will postpone (set maintenance) for 10 minutes for the device with ID 7394 from 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": "Bulk timed postpone has been set."

}