ListBackupJobMode

July 21, 2025

This API can be used to list all backup job information at a specific date.

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/ListBackupJobMode.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 Backup set ID.
BackupDate String Date of backup, in yyyy-MM-dd format.
Return Values
Key Type Description
Status String "OK" or "Error"
Data Array See Record.
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

Record

Key Type Description
ID String ID of the record.
LoginName String Name of the backup user.
Owner String Owner of the backup user.
UserId String ID of the backup user.
StartTime String Time the backup job started.
EndTime String Time the backup job finished.
BackupSetID String ID of the backup set.
BackupSetName String Name of the backup set.
BackupJobMode String The backup job mode response can be one of the following: R = Remote backup, M = Manual backup, S = Scheduled backup or null = no backup.
Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupDate":"2024-06-26-11-33-52"
}

OUTPUT

{
	"Status":"OK",
	"Data":[
		{
			"BackupSetName":"v6 File Backup",
			"LoginName":"obm",
			"Owner":"",
			"EndTime":"2024-06-26 11;34:15",
			"UserId":"obm",
			"StartTime":"2024-06-26 11:33:52",
			"BackupJobMode":"M",
			"BackupSetID":"1687750405259"
		}
	]
}
Documentation