Request URL

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

Path Parameters

Field Type Required Description
scheduler_id

string

true

 The scheduler unique id.
Example request URL

https://api.dotcom-monitor.com/config_api_v1/scheduler/789

Success Response

Example Response
{
"Id": 832,
"Name": "maintenance window (updated)",
"Description": "",
"Weekly_Intervals": [{
"Days": ["Su", "Mo", "Tu", "We", "Th", "Fr", "Sa"],
"From_Min": 0,
"To_Min": 1439,
"Included": true
}, {
"Days": ["Su", "Sa"],
"From_Min": 0,
"To_Min": 1439,
"Included": false
}, {
"Days": ["Su", "Mo", "Fr", "Sa"],
"From_Min": 120,
"To_Min": 240,
"Included": false
}],
"Date_Time_Intervals": [{
"From": 1358712000000,
"To": 1358798400000
}],
"Assigned_To": {
"Devices": [8533, 8550, 8560],
"Notification_Groups": [613]
}
}

Fields Description

Field Type Description

Name

String

 Scheduler name.

Example:
"Scheduler_Name":"maintenance window"

Description

String

 Scheduler  description.

Example:
"Scheduler_Description":"some notes"

Weekly_Intervals

Array of Objects

 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":true
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
      },
]

Date_Time_Intervals

Array of Objects

 This describes non-repeat intervals.

Time format is given in UNIX time.

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

Assigned_To

Array of Objects

 READ ONLY Field.

This field reflects all devices and Alert Groups which have this scheduler assigned.

Example:
"Assigned_To":
      {
            "Devices":[8692],
            "Notification_Groups":[612]
      }