ListBackupFiles

July 21, 2025

The v1 API only works for backup data backed up by version 6 or older backup clients. While the v2 API only works for backup data backed up by version 10 or above backup clients.

v1 ListBackupFiles.do

URL

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

Deprecated Since Version: 7.15.6.38

v2 ListBackupFiles.do

URL

https://CBS.EXAMPLE.COM/obs/api/json/2/ListBackupFiles.do

Available Since Version: 10.1.0.0

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. Only for v1 API.
SessionID	String	Session ID returned from opening the index file. Obtainable in OpenBackupIndex API. Only for v2 API.
BackupJobID	String	Backup job ID. Obtainable in GetBackupSets API.
Path	String	Path to the backup files.
ListAll	Boolean	If true, all files are listed starting from the root directory.

Return Values

Key	Type	Description
Status	String	"OK" or "Error"
Data	Array	Information of the backup set. Only for v1 ListBackupFiles API.
Contents	Array	Array of files/directories under the path. Only for v2 ListBackupFiles API.
ListStatus	String	Status of the listing, either ONGOING or COMPLETED. Only for v2 ListBackupFiles API.
ListID	String	ID of the ongoing listing, to be used in GetListBackupFilesResult API. Will only be returned if ListStatus is ONGOING. Only for v2 ListBackupFiles API.
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

Backup File (for v1)

Key	Type	Description
Type	String	D is for directory and F is for file.
Name	String	Name of the backup file.
FullPath	String	Path to the file.
OriginalFileSize	Long	Original file size of backup.
FileSize	Long	Size of the backup file.
BackupedByJob	String	Job that backed up the file.
InBackupJob	String	Backup jobs with backup file.
LastModified	Long	Date of last change.

Contents (for v2)

Key	Type	Description
OriginalFileSize	Long	Original file size of backup.
LastModified	Long	Date of last change.
Type	String	D is for directory and F is for File.
InBackupJob	String	Current backup job.
DisplayName	String	Display name of the backup.
FullPath	String	Path to the file.
BackupedByJob	String	Job that backed up the file.
Name	String	Name of the backup file.
FileSize	Long	Size of the backup file.
VirtualPath	String	The path of Microsoft 365 / Google Workspace backup.

Examples

Example 1: v1 ListBackupFiles API

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687750405259",
	"BackJobID":"2024-06-26-11-43-15",
	"Path":"C:\\",
	"ListAll":true
}

OUTPUT

{
	"Status":"OK",
	"Data":[
		{
			"OriginalFileSize":0,
			"LastModified":"0",
			"Type":"0",
			"InBackupJob":"Current",
			"FullPath":"C:\\",
			"BackupedByJob":"2024-06-26-11-33-52",
			"Name":"",
			"FileSize":1536
		},
			"OriginalFileSize":0,
			"LastModified":"0",
			"Type":"0",
			"InBackupJob":"Current",
			"FullPath":"C:\\Users",
			"BackupedByJob":"2024-06-26-11-33-52",
			"Name":"Users",
			"FileSize":1536
		},
			"OriginalFileSize":174,
			"LastModified":"1575709962747",
			"Type":"F",
			"InBackupJob":"Current",
			"FullPath":"C:\\Users\\Public\\Desktop\\desktop.ini",
			"BackupedByJob":"2024-06-26-11-33-52",
			"Name":"desktop.ini",
			"FileSize":1716
		}
	]
}

Example 2: v2 ListBackupFiles API