Scheduler edit request consist of the same data you get when you pull out Scheduler info. This info can be processed according to your goals and POSTed back to the same Scheduler URI.

Request URL

POST  https://api.dotcom-monitor.com/config_api_v1/scheduler/{scheduler_id}

Path Parameters

Field Type Required Description
scheduler_id

string

true

 The unique id of the scheduler you need to edit.

Header Parameters

Content-Type: application/json
Example PUT / POST body
{
"WeeklyIntervals":
[
{
"Day":["Su","Mo","Tu","We","Th","Fr","Sa"],
"From":720,
"To":1439,
"Included":true
},
{
"Day":["Su","Sa"],
"From":720,
"To":1439,
"Included":false
}
],
"DateTimeIntervals":
[
{
"From":1358668800,
"To":1358712000
}
],
}

Required Body Parameters

To edit a scheduler parameters, we recommend you get an existed scheduler info first and use the response as a sample.

TIME FORMAT

Please note that the time interval should be given in UNIX time format:

"Date_Time_Intervals": [{
 "From": 1358712000000,
 "To": 1358798400000
 }]
Field Type Required/Optional Description

Name

String

required

 Scheduler name.

Example:
"Scheduler_Name":"maintenance window"

Weekly_Intervals

Array of Objects

required

 This describes intervals which repeat on a weekly basis

POSSIBLE DAYS VALUES:

“Su”,”Mo”,”Tu”,”We”,”Th”,”Fr”,”Sa”,”Su”

MEANS PROCESSING IS ENABLED
"Included":true
MEANS PROCESSING IS DISABLED
"Included":false
Example:
"Weekly_Intervals": [{
      "Days": ["Tu", "We", "Th", "Fr", "Sa"],
      "From_Min": 0,
      "To_Min": 1025,
      "Included": true
      }, {
      "Days": ["Su", "Sa"],
      "From_Min": 0,
      "To_Min": 1139,
      "Included": false
      },
]
To specify the time interval that covers a full day set “From_Min” to 0 and
“To_Min” to 1439:
"Weekly_Intervals": [{
      "Days": ["Tu", "We", "Th", "Fr", "Sa"],
      "From_Min": 0,
      "To_Min": 1439,
      "Included": true
      }
]

Date_Time_Intervals

Array of Objects

required

 This describes non-repeat intervals.

Time format is given in UNIX time.

Note that the seconds value should be 0 when converting “From” and “To” intervals to epoch time.

Example:
"Date_Time_Intervals": [{
            "From": 1358712000000,
            "To": 1358798400000
      }]

Success Response

Example response
{
"Success": true,
"Result": "Scheduler 6954 has been updated"
}