Request URL

Schedulers can be created using two methods:

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

 Header Parameters

Content-Type: application/json
Example PUT / POST body
{
"Name": "new scheduler",
"Description": "description",
"Weekly_Intervals": [{
"Days": ["Su", "Mo", "Tu", "We", "Th", "Fr", "Sa"],
"From_Min": 0,
"To_Min": 1025,
"Included": true
}, {
"Days": ["Su", "Sa"],
"From_Min": 0,
"To_Min": 1139,
"Included": false
}, {
"Days": ["Su", "Mo", "Fr", "Sa"],
"From_Min": 120,
"To_Min": 240,
"Included": false
}],
"Date_Time_Intervals": [{
"From": 1358712000000,
"To": 1358798400000
}]
}

Required Body Parameters

To specify a JSON object parameters for a new scheduler, we recommend you get an existed scheduler info first and use the response as a sample for a new scheduler object.

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.

The time format is given in UNIX time.

Note that the seconds part of the 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":871
}