ListBackupJobs

July 21, 2025

This API can be used to show the basic information of all backup jobs performed by a specific user.

The settings can be found on the AhsayCBS web console at:

  • Monitoring > Backup / Restore Logs > Backup Jobs

URL

https://CBS.EXAMPLE.COM/obs/api/json/ListBackupJobs.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.
SkipEmpty Boolean If true, backup set with no files is skipped.
Return Values
Key Type Description
Status String "OK" or "Error"
Data Array See Backup Set.
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".
JSON Objects

Backup Set

Key Type Description
BackupSetID String ID of the backup set.
Removed Boolean Shows whether the backup set is removed.
BackupJob Array of Strings Array list of backup jobs.
Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm"
}

OUTPUT

{
	"Status":"OK",
	"Data":[
		{
			"BackupJob":[
				"2024-06-26-11-33-52"
			],
			"BackupSetID":"1687750405259",
			"Removed":false
		}
	]
}
Documentation