Get Backup Schedule


This request returns the specified backup schedule.

The backup schedule object contains a list of backup logs, this is shown without the actual log details
If the log details are needed, the request get backup log can be used where <OID> is the object id of the log.

Resource

GET /backupschedules/<OID>

Parameters

None

Payload

None

Context

Authorization

Master

Errors

Example

Request
GET https://xelion.nl/api/v1/master/backupschedules/1757883
Response
{
  "object": {
    "externalDevice": {
      "type": "localDirectory",
      "location": "/usr/xelion/XCC/initdb",
      "usbId": "",
      "smbUserName": "",
      "smbPassword": "",
      "smbVersion": "",
      "ssl": false,
      "subDirectory": "",
      "oid": "1816046",
      "objectType": "XCCExternalDevice"
    },
    "maxBackups": 10,
    "backupDatabase": true,
    "centralBackup": true,
    "backupAllTenants": false,
    "tenant": {
        "commonName": "pbx1",
        "oid": "1",
        "objectType": "XCCTenant"
    },
    "schedules": [
      {
        "day": "monday",
        "startTime": "01:00",
        "oid": "1738054",
        "objectType": "XCCBackupStart"
      }
    ],
    "backupLogs": [
      {
        "timeStamp": "2018-01-04 18:29:59",
        "timeStampEnd": "",
        "backupFile": "xps6_2018-01-04_18-30-00.dmp",
        "status": "SUCCESS",
        "oid": "1738059",
        "objectType": "XCCBackupLog"
      }
    ],
    "permissions": "ReadWriteRemove",
    "commonName": "backup123",
    "oid": "1738053",
    "objectType": "XCCBackupSchedule"
  },
  "links": [
    {
      "rel": "self",
      "href": "https://xelion.nl/api/v1/master/backupschedules/1738053",
      "method": "GET"
    }
  ]
}