You can use GetSchedule to get information about a scheduled snapshot.

You can see information about a specific schedule if there are many snapshot schedules in the system. You also retrieve information about more than one schedule with this method by specifying additional IDs in the scheduleID parameter.


This method has the following input parameter:

Name Description Type Default value Required
scheduleID Unique ID of the schedule or multiple schedules to display. integer None Yes

Return value

This method has the following return value:

Name Description Type
schedule An array of schedule attributes. schedule array

Request example

Requests for this method are similar to the following example:

"method": "GetSchedule", 
  "params": {
              "scheduleID" : 2
   "id" : 1

Response example

This method returns a response similar to the following example:

  "id": 1,
  "result": {
    "schedule": {
      "attributes": {
        "frequency": "Time Interval"
       "hasError": false,
       "hours": 0,
       "lastRunStatus": "Success",
       "lastRunTimeStarted": "2015-03-23T21:25:00Z",
       "minutes": 2,
       "monthdays": [],
       "paused": false,
       "recurring": true,
       "runNextInterval": false,
       "scheduleID": 2,
       "scheduleInfo": {
          "name": "MCA2",
          "volumeID": "3"
       "scheduleName": "MCAsnapshot2",
       "scheduleType": "Snapshot",
       "startingDate": "2015-03-23T19:28:57Z",
       "toBeDeleted": false,
       "weekdays": []

New since version