Update backup schedule

User Guide > Resources > Update Backup Schedules

This request changes backup schedule attributes.

Resource

PATCH /backupschedules/<OID>

Where OID is the oid of the backup schedule

Parameters

None

Payload

Patch Document

Fields

Name Patch Operations

maxBackups

replace

centralBackup

replace

backupType

replace

backupAllTenants (only multitenant)

replace

tenant (only multitenant)

replace

External Device

externalDevice.type

replace

externalDevice.location

replace

externalDevice.usbId

replace

externalDevice.smbUserName

replace

externalDevice.smbPassword

replace

externalDevice.smbVersion

replace

externalDevice.ssl

replace

externalDevice.subDirectory

replace

externalDevice.mode

replace

Schedules List

schedules

add, remove, replace submember

schedules.day

replace

schedules.startTime

replace

Response

None

Context

Authorization

Master

Errors

Common Errors

Example

Request
PATCH https://xelion.nl/api/v1/master/backupschedules/1627410
Payload

change backup schedule direct member

{
    "operations": [
            {
            "op": "replace",
            "path": "/maxBackups",
            "value": 5
            }
    ]
}
{
    "operations": [
            {
            "op": "replace",
            "path": "/centralBackup",
            "value": false
            }
    ]
}
{
    "operations": [
            {
            "op": "replace",
            "path": "/tenant",
            "value": 2
            }
    ]
}

change backup schedule external device member

{
    "operations": [
            {
              "op": "replace",
              "path": "/externalDevice/type",
              "value": "windowsShare"
            }
    ]
}

add new schedule to the backup schedule, first add a new object with virtual id 1 and then set the submember(s) by adding replace operations on the virtual id '1'

{
    "operations": [
            {
              "op": "add",
              "path": "/schedules/1",
            },
            {
              "op": "replace",
              "path": "/schedules/1/day",
              "value": "tuesday"
            }
    ]
}

remove schedule from backup schedule, <OID> is the oid of the schedule

{
     "operations": [
            {
              "op": "remove",
              "path": "/schedules/1726623"
            }
    ]
}

change schedule submember, <OID> is the oid of the schedule

{
    "operations": [
            {
              "op": "replace",
              "path": "/schedules/1726623/startTime",
              "value": "00:50"
            }
    ]
}