DeleteBackupSet

July 21, 2025

This API allows you to delete a backup set of a user.

URL

https://CBS.EXAMPLE.COM/obs/api/json/DeleteBackupSet.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.
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, will only be displayed if the status is "Error".
Examples

Example 1

INPUT

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

OUTPUT

{
	"Status":"OK"
}

Example 2: Backup set contains non-AhsayCBS destination

INPUT

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

OUTPUT

{
	"Status":"Error",
	"Message":"Cannot delete the backup set 'Test_Name(1687501131522)' because the standard destination 'dest_Local' is used. Please delete the backup set via backup client console.",
	"ExptType":"com.ahsay.obs.core.dbs.DbsException"
}

Example 3: Login name does not exist or incorrect

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"test_user",
	"BackupSetID":"1687501131522"
}

OUTPUT

{
	"Status":"Error",
	"Message":"[UserCacheManager.NoSuchUserExpt] User ‘test_user’ not found.",
	"ExptType":"com.ahsay.obs.core.dbs.ad"
}

Example 4: Backup set ID is incorrect

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"test_user",
	"BackupSetID":"1687501131500"
}

OUTPUT

{
	"Status":"Error",
	"Message":"Backup set ‘1687501131500’ not found.",
	"ExptType":"com.ahsay.obs.core.dbs.DbsException"
}
Documentation