Create Backup Schedule

User Guide > Create backup schedule

This request adds a backup schedule to the database.

Resource

POST /backupschedules

Parameters

Common Create Parameters

Payload

Backup Schedule

Response

Object Response < XCCBackupSchedule >

The created object.

Context

Authorization

Master

Errors

Common Errors

Example

Request
POST https://xelion.nl/api/v1/master/backupschedules
Payload
{
    "maxBackups": 10,
    "centralBackup": true,
    "externalDevice":
    {
      "type": "localDirectory",
            "location": "/usr/xelion",
            "usbId": "",
            "smbUserName": "",
            "smbPassword": ""
    },
    "backupAllTenants": false,
    "backupType": "single",
    "tenant": {
        "commonName": "pbx1",
        "oid": "2",
        "objectType": "XCCTenant"
    },
    "tenant": null,
    "schedules": [
      {
        "day": "monday",
        "startTime": "01:00",
        "objectType": "XCCBackupStart"
      }
    ],
    "commonName": "backup123",
    "objectType": "XCCBackupSchedule"
}
Response
{
    "object": {
        "externalDevice": {
            "type": "localDirectory",
            "location": "/usr/xelion",
            "usbId": "",
            "smbUserName": "",
            "smbPassword": "",
            "ssl": false,
            "subDirectory": "",
            "oid": "1823913",
            "objectType": "XCCExternalDevice"
        },
        "maxBackups": 10,
        "centralBackup": true,
        "backupAllTenants": false,
        "backupType": "single",
        "schedules": [
            {
                "day": "monday",
                "startTime": "01:00",
                "oid": "1823915",
                "objectType": "XCCBackupStart"
            }
        ],
        "backupLogs": [],
        "permissions": "ReadWriteRemove",
        "commonName": "backup123",
        "oid": "1823909",
        "objectType": "XCCBackupSchedule"
    },
    "links": [
        {
            "rel": "self",
            "href": "https://xelion.nl/api/v1/master/backupschedules/1823909",
            "method": "GET"
        }
    ]
}