GetSingleUserRebuildStatus

July 21, 2025

This API allows you to get the information of the recent v6 legacy backup set rebuild.

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

  • Monitoring > Administration Logs > Audit Trails

 

URL

https://CBS.EXAMPLE.COM/obs/api/json/GetSingleUserRebuildStatus.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).
Return Values
Key Type Description
Status String "OK" or "Error"
Data JSON Object RebuildStatus Refer to JSON Objects - Rebuild Status.
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

RebuildStatus

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 1 

{
	"Status":"OK",
	"Data":{
		"Status":"Finished",
		"LoginName":"obm",
		"EndTime":1686640128382,
		"StartTime":1686640127867,
		"BackupSetID":"1686639360356"
	}
}

OUTPUT 2: Not yet started 

{
	"Status":"OK",
	"Data":{
		"Status":"Not yet started",
		"LoginName":"obm",
		"EndTime":-1,
		"StartTime":-1,
		"BackupSetID":""
	}
}
Documentation