RunBackup

July 21, 2025

This API can be used to start a backup for a specific user or to cancel a pending backup job from the server initiated backup job list.

URL

https://CBS.EXAMPLE.COM/obs/api/json/RunBackup.do

Available Since Version: 9.1

Parameters

Key Type Description
SysUser String Username of an AhsayCBS System User with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Username of the backup user.
BackupSetID String ID of the backup set. Obtainable in ListBackupSets API.
CancelBackup Boolean This option can be used to cancel a pending backup job from the server initiated backup job list. Cannot be used to stop / cancel an in process (running) backup job.
BackupType String

Type of backup. It must be empty for File, MySQL, MariaDB, Lotus Notes, System State, MS Windows Server 2008, MS Exchange Mail Level Backup, Cloud File, Microsoft 365 Exchange Online and Linux Bare Metal backup sets.

For the following Backup Types, this parameter must be filled with one of the following:

MS Exchange Server (if VSS supported): DATABASE, LOG, COPY or DIFFERENTIAL.

If not VSS supported: DATABASE or LOG.

Oracle Database Server Backup, Lotus Domino & Tibero Database Server Backup: DATABASE or LOG.

MS SQL Server Backup: DATABASE, DIFFERENTIAL or LOG.

ShadowProtect System Backup: COMPLETE, DIFFERENTIAL or INCREMENTAL.

MS Hyper-V Backup:INCREMENTAL or DATABASE.

VMware Backup (VMware ESXi 5.5 / 6 / 6.5 / 6.7 / 7.0 / 8.0 or VMware vCenter 5.5 / 6 / 6.5 / 6.7 / 7.0 / 8.0): DATABASE or INCREMENTAL.

VMware Player 6 / 7/ VMware Workstation Player 12 / 14 / 15 / 16: SKIP or POWER-OFF.

VMware Workstation 10 / 11 / VMware Workstation Pro 12 / 14 / 15 / 16 or VMware Fusion 6 / 7 / 8 / 10 / 11 /12: leave blank.

Return Values
Key Type Description
Status String "OK" or "Error"
Data Array Array list of data
Message String Error message, it only appears if status displays "Error".
ExptType String The type of exception, will only be displayed if the status is "Error".
Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"username",
	"BackupSetID":"1462518403716"
}

OUTPUT

{
	"Status":"OK"
}
Documentation