GetListBackupFilesResult

July 21, 2025

This API will list the backup files result.

URL

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

Available Since Version: 10.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.
SessionID String Session ID returned from opening the index file.
ListID Boolean ID of the ongoing listing from ListBackupFiles API.
Return Values
Key Type Description
Status String "OK" or "Error"
Contents Array Array of files/directories under the path same with ListBackupFiles.
ListStatus String Status of the listing, either ONGOING or COMPLETED.
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

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 Long Original file size of backup.
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.
Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"user",
	"SessionID": "92518cbc-8805-4dcd-b4f8-f2ac3a75ad9e"
}

OUTPUT

{
    "Status": "Error",
    "ExptType": "com.ahsay.obs.core.dbs.DbsException",
    "Message": "[Error] Parameter ListID is null/empty!"
}
Documentation