RunSingleUserRebuild

July 21, 2025

This API rebuilds a particular v6 legacy backup set of a user.

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

  • Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > Backup Set > %v6 Backup Set Name% > Destination > Standard Destination > Rebuild

 

URL

https://CBS.EXAMPLE.COM/obs/api/json/RunSingleUserRebuild.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 Name of the backup user.
Owner String The owner of backup user (if applicable).
BackupSetID String ID of the backupset. Obtainable in GetBackupset API.
CheckCrc Boolean Cyclic redundancy check.
Return Values
Key Type Description
Status String "OK" or "Error"
Message String Error message, it only appears if status displays "Error".
ExptType String The type of exception, it appears only if status is "Error".
JSON Objects

Rebuild Status

Key Type Description
LoginName String Name of backup user.
BackupSetID String ID of the backup set.
Status String Status of the rebuild.
StartTime Long Time when rebuild started.
EndTime Long Time when rebuild ended.
Example

INPUT 

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

OUTPUT 

{
	"Status":"OK"
}

OUTPUT 2: Backupset does not exist 

{
	"Status":"OK",
	"Message":"Backup Set for ID='1686639360356' not found",
	"ExptType":"com.ahsay.obs.core.dbs.DbsException"
}
Documentation