GetDataMigrationProgress

July 21, 2025

This API can be used to get the v6 to AhsayCBS Blocks Backup Set Data Migration. 

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

  • Backup/Restore > Basic > Backup Data Migration

BackupData Migration

URL

https://CBS.EXAMPLE.COM/cbs/api/json/GetDataMigrationProgress.do

Available Since Version: 7.7

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.
Return Values
Key Type Description
Status String "OK" or "Error"
Message String Error message, it only appears if "status" displays "Error".
MigratedFileCount Integer Number of file that has been migrated for the current backup set.
MigratingFilePath String The file path that is under migration.
Example

INPUT 

{
	"SysUser":"api_user",
	"SysPwd":"qWeRtY123456!@#$%"
}

OUTPUT 

{
	"Status":"OK",
	"MigratingFilePath":"C:\\ProgramFiles\AhsayCBS\users\user\files\15544253452756\Current\0x14\0x45\0x12\0x00\5252334",
	"MigratedFileCount":"15"
}
Documentation