GetBackupJobProgress

July 21, 2025

This API can be used to retrieve current progress of a backup job.

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/GetBackupJobProgress.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.
DestinationID String Destination ID. Obtainable by calling the GetBackupSets API.
BackupJobID String Backup job ID. Obtainable by calling the GetBackupSets API.
Return Values
Key Type Description
Status String "OK" or "Error"
Data Record Refer to 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 Unique to each backup user.
StartTime String Time when backup job started. In yyyy-MM-dd HH:mm:ss format.
EndTime String Time when backup job finished. In yyyy-MM-dd HH:mm:ss format.
BackupSetID String ID of the backup set.
BackupSetName String Name of the backup set.
CurrentFileName String Name of the current file being backed up.
FileUploadTime String Time when file was uploaded. In yyyy-MM-dd HH:mm:ss format.
CurrentFileCount String Count of current file.
TotalFileCount String Total count of all files.
UploadedFileSize String Total size of uploaded files.
TotalFileSize String Total size of all files.
Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687505199600",
	"DestinationID":"1687505211240,
	"BackupJobID":"2024-06-23-15-27-57"
}

OUTPUT

{
	"Status":"OK",
	"Data":{
		"BackupSetName":"default-backup-set-name-1",
		"LoginName":"obm",
		"Owner:"",
		"EndTime":"2024-06-23 15:29:37",
		"TotalFileCount":"70",
		"StartTime":"2024-06-23 15:28:16",
		"BackupSetID":"1687505199600",
		"UserID":"obm",
		"UploadedFileSize":"70479290",
		"CurrentFileName":"C:\\Users\\ahsay\\Desktop\\file_sample.exe",
		"TotalFileSize":"78477452",
		"ID":"2024-06-23-15-27-57",
		"CurrentFileCount":"0"
}
Documentation