ListRestoreJobs

July 21, 2025

This API can be used to list all restore jobs of each backup set owned by specified users.

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

  • Monitoring > Backup / Restore Logs > Restore Jobs

URL

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

Available Since Version: 9.1

Parameters

Key Type Description
SysUser String Username of an AhsayCBS System User with Admin, API or Read-Only API role.
SysPwd String Password matching SysUser.
LoginName String Username of the backup user.
Return Values
Key Type Description
Status String "OK" or "Error"
Data JSON Object See 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".
JSON Objects

Data

Key Type Description
BackupSetID String ID of the backup set.
Removed Boolean Shows whether the backup set is removed.
RestoreJob Array of String Timestamp in yyyy-mm-dd-HH-mm-ss format.
Example

INPUT

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

OUTPUT

{
	"Status":"OK",
	"Data":[
		{
			"RestoreJob":[
				"2024-06-26-13-25-13"
			],
			"BackupSetID":"1687755057644",
			"Removed":false
		}
	]
}
Documentation