ListBackupSets

July 21, 2025

This API can be used to show the name, type and ID of all backup sets of a specific user.

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

  • Backup / Restore > Users, Groups & Policies > %User Name% > Backup Set

URL

https://CBS.EXAMPLE.COM/obs/api/json/ListBackupSets.do

Available Since Version: 9.7

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.
ListAll Boolean True or False, shows all information for all backup sets of specified backup user.
Return Values
Key Type Description
Status String "OK" or "Error"
Data Array See Backup Set.
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".
ModuleUsage JSON Object See ModuleUsage.
JSON Objects

Backup Set

Key Type Description
ID String ID of the backup set.
Name String Name of the backup set.
Type String Type of backup set.

ModuleUsage

Key Type Description
ModuleUsage Long Usage of module license by the backup set.
ModuleType String Type of module used by the backup set. Can be one of the following: Office365Mail, MSExMailbox, MSHyperVVM or VMwareVM.
HostCount Long Usage of AhsayOBM / AhsayACB license by the backup set.
Examples

Example 1: If "ListAll" parameter is not used or is false

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"ACB"
}

OUTPUT

{
	"Status":"OK",
	"Data":[
		{
			"Type":"FILE",
			"ID":"1692320086130",
			"Name":"BackupSet-1"
		},
		{
			"Type":"Office 365 Exchange Online",
			"ID":"1692322592995",
			"Name":"M365-1"
		},
		{
			"Type":"Office 365 Exchange Online",
			"ID":"1692674960375",
			"Name":"M365-2"
		}
	]
}

Example 2: If "ListAll" parameter is set to true / snippet of Module Usage

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"ACB",
	"ListAll":true
}

OUTPUT

{
...
	"ModuleUsage":{
		"ModuleUsage":5,
		"ModuleType":"Office365Mail",
		"HostCount":1
	}
}
API results will vary depending on the usage of the parameter "ListAll".
Documentation