Restore Backup

This request restores a backup from a backup schedule.
The filename should be available in the backup schedule directory, you can find the list of availble files by using the get restore files call.
The tenant should only be applied when the system is multitenant. In a multitenant environment there is also the option to restore all tenants at once. In that case, it is not necessary to pass a filename. The backup files will automatically be retrieved by the backend.
Give up the correct restore mode, single, split, essential, remaining.

Resource

PUT /backupschedules/<OID>/restore

Parameters

None

Payload

An BackupRestoreInfo object containing the information about the backup restore.

Response

None

Context

Authorization

Master

Errors

Common Errors

Example

Request

PUT https://xelion.nl/api/v1/master/backupschedules/1757883/restore

Payload

Example - restore single tenant

{
    "fileName":"xps6t_pbx25_2017-08-08_01-04-54.dmp",
    "tenant": {
        "commonName": "pbx1",
        "oid": "1",
        "objectType": "XCCTenant"
    }
}

Example - restore all tenants

{
    "allTenants": true,
    "mode": "ESSENTIAL"
}