GetBackupSet (v1,v2)

July 21, 2025

This API can be used to retrieve backup set information.

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

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

v1 GetBackupSet.do

URL

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

Deprecated Since Version: 7.15.6.38

v2 GetBackupSet.do

URL

https://CBS.EXAMPLE.COM/obs/api/json/2/GetBackupSet.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.
BackupSetID String Backup set ID.
GwsDocCopyDestID String Google workspace type backup set specified parameter, may obtain in GetBackupSet response.
Return Values
Key Type Description
Status String "OK" or "Error"
Data Array Information of the 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".
DeduplicationSettings Object Refer to DeduplicationSettings in UpdateBackupSet API.
JSON Objects

Data

For details on all parameters returned by GetBackupSet.do, please refer to the input parameters outlined in the UpdateBackupSet section.

Array of DestinationList (Data{}:DestinationSettings{}:DestinationList[])

Key Type Description
@class String Classification of the different backup sets.
DataMigrationMappingMergedToIndex Boolean True / False
DataMigrationStatus String For v6 backup set. The different status are: NotStarted, Running, Finished and Verified.
DestinationKey String Key of the destination.
HostName String Hostname or IP of the host.
Id String ID of the destination.
IndexMigrateLastAccess Long Last index migration access.
Name String Name of the destination.
Password String Password used to login to the destination.
Port Long Post used by the destination.
QuotaInfo String Quota of the destination (if any).
ReadOnly Boolean True / False
RunDirectEnabled Boolean True / False
Sslcertificates Array Array list of SSL certificates.
Statistics Object Refer to Statistics.
TopDir String First directory.
Type String Type of directory.
UserName String Username used to access the directory.
UsingProxy Boolean True / False
UsingSSL Boolean True / False
V6ClusterMigrateLock String For v6 backup set. Check if other cluster nodes are performing migration. If "Empty", not running Stage 1 so no need to lock.
V6DataMigrateLock String Unused. For v6 backup set.
V6Index2Migrate Boolean For v6 backup set. If "False", v7+ backup set. If "True", backup set is still v6 and has not undergone Stage 1 (v6 index migration).
Statistics (Data{}:DestinationSettings{}:DestinationList{}:Statistics{})
Key Type Description
LastBackupClientVersion String Version used during last backup.
LastBackupCompleteTime Long Time last backup was completed.
LastBackupJobID String ID of last backup job.
LastBackupStartTime Long Time last backup was started.
LastCdpBackupCompleteTime Long Time last CDP backup was completed.
LastCdpBackupStartTime Long Time last CDP backup was started.
LastDeltaMergeTime Long Time of last delta merge.
LastDICTime Long Time of last data integrity check.
LastDICVersion String Version of last data integrity check.
LastOffice365DSCTime Long Time of last Microsoft 365 data synchronization check.
LastRestoreTime Long Time of last restore.
LastStorageRebuildTime Long Time of last storage rebuild.
LastSuccessBackupJobID String ID of the last successful backup.
Pdicrun Boolean True / False
TotalBackupCount Integer Total count of backups.
TotalRestoreCount Integer Total count of restores.
TotalRestore Object Refer to TotalRestore.
LastBackup Object Refer to LastBackup.
DataArea Object Refer to DataArea.
DedupeSaving Object Refer to DedupeSaving.
RetentionArea Object Refer to RetentionArea.
LastRestore Object Refer to LastRestore.
TotalBackup Object Refer to TotalBackup.

TotalRestore (Data{}:DestinationSettings{}:DestinationList{}:Statistics{}:TotalRestore{})

Key Type Description
Type String TOTAL_RESTORE.
FileCount Integer Number of files.
CompressedSize Long Size of compressed files.
UncompressedSize Long Size of uncompressed files.

LastBackup (Data{}:Destination{}:Statistics{}:LastBackup{})

Key Type Description
Type String LAST_BACKUP.
FileCount Integer Number of files.
CompressedSize Long Size of compressed files.
UncompressedSize Long Size of uncompressed files.

DataArea (Data{}:DestinationSettings{}:DestinationList{}:Statistics{}:DataArea{})

Key Type Description
Type String DATA_AREA.
FileCount Integer Number of files.
CompressedSize Long Size of compressed files.
UncompressedSize Long Size of uncompressed files.

DedupeSaving (Data{}:DestinationSettings{}:DestinationList{}:Statistics{}:DedupeSaving{})

Key Type Description
Type String DEDUPE_SAVING.
FileCount Integer Number of files.
CompressedSize Long Size after deduplication.
UncompressedSize Long Uncompressed original size.

RetentionArea (Data{}:DestinationSettings{}:DestinationList{}:Statistics{}:RetentionArea{})

Key Type Description
Type String RETENTION_AREA.
FileCount Integer Number of files.
CompressedSize Long Size of compressed files.
UncompressedSize Long Size of uncompressed files.

LastRestore (Data{}:DestinationSettings{}:DestinationList{}:Statistics{}:LastRestPre{})

Key Type Description
Type String LAST_RESTORE.
FileCount Integer Number of files.
CompressedSize Long Size of compressed files.
UncompressedSize Long Size of uncompressed files.

TotalBackup (Data{}:DestinationSettings{}:DestinationList{}:Statistics{}:TotalBackup{})

Key Type Description
Type String TOTAL_BACKUP.
FileCount Integer Number of files.
CompressedSize Long Size of compressed files.
UncompressedSize Long Size of uncompressed files.

ModuleUsage

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

Example 1

INPUT

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

OUTPUT

{
	"Status":"OK",
	"Data":{
		"Timezone":"1098",
		"Delete":false,
		"Owner":null,
		"DisplayOwner":"-",
		"Os":"windows",
		"RunBackupSettings":{
			"DestinationIDList":[],
			"Enabled":false,
			"BackupType":"",
			"BackJobID":""
			"Id":""
		},
		"RunOnServer":false,
		"V6Passwords":{
			"ApplicationPassword":"",
			"WinUserAuthPassword":"",
			"Id":""
		},
		"SelectedShortcutList":[],
		"EnsureTopDirExistenceInLogin":true,
		"PreCommandList":[],
		"ApplicationSupportHyperVRunDirect":false,
		"RecycleBinSettings":{
			"Enabled":true,
			"Id":"",
			"RetentionPeriod":7
		},
		"Name":"default-backup-set-name-1",
		"FollowLink":true,
		"NasEncryptionKey":null,
		"ApplicationSupportBackupMacResourceData":false,
		"DataMigrationSettings":{
			"IntegrityCheckLastAccess":0,
			"DataMigrationMappingStart":false,
			"Id":"",
			"MigrationProgress":{
				"ReadOnly":false,
				"NumOfCompletedFiles":0,
				"CurrentMigratingFilePath":"",
				"Id":"",
				"TotalNumOfFiles":0
			},
			"SpaceFreeUpLastAccess":0
		},
		"OpenDirectEnabled":false,
		"EnableBackupEFSFile":true,
		"InFileDeltaSettings":{
			"MaxDeltaRation":50,
			"MinDeltaFileSize":26214400,
			"MonthlyInFileDeltaSchedule":{
				"Month":[
					"",
					"",
					"",
					"",
					"",
					"",
					"",
					"",
					"",
					"",
					"",
					""
				],
				"Criteria":"Friday",
				"Occurence":"First",
				"Date":0
			},
			"MaxNumOfDelta":100,
			"DeltaBlockSize":-1,
			"DeltaMergeEnabled":false,
			"UploadFullIfGenDeltaFailed":true,
			"Enabled":true,
			"WeeklyInFileDeltaSchedule":{
				"Day":[
					"",
					"",
					"",
					"",
					"",
					"",
					""
				],
				"Id":"",
				"DefaultDeltaType":"D"
			},
			"EncryptionSettings":{
				"Type":"DEFAULT",
				"KeyType":"hash",
				"InputStream":{},
				"Mode":"CBC",
				"NasKey":null,
				"Id":"",
				"Algorithm":"AES",
				"KeyLength":256,
				"Key":""
			},
			"LogoutType":"",
			"BackupTargetAsUNCPath":false,
			"LogRetentionDays":-1,
			"UsedQuota":0,
			"FilterSettings":{
				"Enabled":false,
				"FilterList":[],
				"Id":""
			},
			"DestinationSettings":{
				"ConcurrencyLevel":1,
				"MaxDestination":1,
				"Id":"",
				"DestinationList":[
					{
						"DeleteToken":"",
						"Immutable":false,
						"V6DataMigrateLock":"",
						"Port":0,
						"Name":"AhsayCBS",
						"UsingSSL":false,
						"V6ClusterMigrateLock":"",
						"DataMigrationMappingMergedToIndex":true,
						"IndexMigrateLastAccess":0,
						"HostName":null,
						"Password":null,
						"DestinationKey":"OBS",
						"ReadOnly":false,
						"@class":"com.ahsay.obx.cxp.obx.ObsDestination",
						"UserName":null,
						"UsingProxy":false,
						"DataMigrationStatus":"Verified",
						"Statistics":{
							"TotalRestore":{
								"Type":"TOTAL_RESTORE",
								"FileCount":0,
								"CompressedSize":0,
								"UncompressedSize":0
							},
							"LastBackup":{
								"Type":"LAST_BACKUP",
								"FileCount":0,
								"CompressedSize":0,
								"UncompressedSize":0
							},
							"DataArea":{
								"Type":"DATA_AREA",
								"FileCount":0,
								"CompressedSize":0,
								"UncompressedSize":0
							},
							"LastDICTime":-1,
							"LastOffice365DSCTime":-1,
							"Pdicrun":false,
							"TotalBackupCount":0,
							"LastRestore":{
								"Type":"LAST_RESTORE",
								"FileCount":0,
								"CompressedSize":0,
								"UncompressedSize":0
							},
							"LastDICVersion":"",
							"LastSuccessBackupJobID":"",
							"TotalRestoreCount":0,
							"LastBackupJobID":"",
							"RecycleBin":{
								"Type":"RECYCLE_BIN",
								"FileCount":0,
								"CompressedSize":0,
								"UncompressedSize":0
							},
							"DedupeSaving":{
								"Type":"DEDUPE_SAVING",
								"FileCount":0,
								"CompressedSize":0,
								"DataSize":0,
								"OriginalSize":0,
								"UncompressedSize":0
							},
							"LastBackupClientVersion":null,
							"LastBackupCompleteTime":-1,
							"LastDeltaMergeTime":-1,
							"LastCdpBackupStartTime":-1,
							"RetentionArea":{
								"Type":"RETENTION_AREA",
								"FileCount":0,
								"CompressedSize":0,
								"UncompressedSize":0
							},
							"LastRestoreTime":-1,
							"LastStorageRebuildTime":-1,
							"LastCdpBackupCompleteTime":-1,
							"TotalBackup":{
								"Type":"TOTAL_BACKUP",
								"FileCount":0,
								"CompressedSize":0,
								"UncompressedSize":0
							},
							"LastIndexUploadedBackupJobID":null
						},
						"V6Index2Migrate":false,
						"Type":"OBS",
						"QuotaInfo":"",
						"Id":"1703141860328",
						"Sslcertificates:[],
						"RunDirectEnabled":false,
						"TopDir":null
					}
				]
			},
			"EffectiveOwner":"-",
			"BackupJobName":"2024-12-21-16-07-10",
			"ApplicationSupportVMwareRunDirect":false,
			"RestoreDrillSettings:{
				"UploadKey":false,
				"RestoreInterval":6,
				"Enable":true,
				"Id":""
			},
			"ReminderSettings":{
				"OfflineBackupReminderComputerName":"",
				"BackupIntervalHour":0,
				"LogoutBackupReminderEnabled":false,
				"BackupIntervalDay":1,
				"ShowOfflineBackupReminder":false,
				"OfflineNotificationDay":7,
				"OfflineBackupEnabled":false,
				"Id":"",
				"LogoutBackupReminderComputerName":""
			},
			"ReadOnlySelectedSourceKeyList":[],
			"EffectiveFilterList":[],
			"TransferSize":262114,
			"LanPassword":"y8/VxMA=",
			"WorkingDir":"",
			"ApplicationSettings":{
				"@class":"com.ahsay.obx.cxp.cloud.TiberoSettings",
				"LoginID":"SYS",
				"Version":"",
				"Port":"1234",
				"Host":"127.0.0.1",
				"LastArchivedLog":"",
				"Id":"",
				"Password":"",
				"Sid":""
			},
			"Ewstype":false,
			"TotalQuota":0,
			"FileViewerEnabled":true,
			"AllowEmptyPathSource":false,
			"BackupTypes":[],
			"UploadPermission":true,
			"Id":"1703141639743",
			"ApplicationSupportOpenDirect":false,
			"VerifyBucketLocationLogin":true,
			"BandwidthControlSettings":{
				"Mode":"share",
				"Enabled":false,
				"Id":"",
				"BandwidthControlList":[]
			},
			"ProxySettings":null,
			"CloudName":"",
			"ScheduleSettings":{
				"DailyScheduleList":[],
				"WeeklyScheduleList:[],
				"CustomScheduleList":[],
				"LastRosPeriodJobAlertTime":0,
				"MonthlyScheduleList":[],
				"ComputerName":"",
				"Enable":false,
				"Id":"",
				"LastRosPeriodJobTriggerTime":0
			},
			"DeselectedSourceList":[],
			"DeleteTempFile":true,
			"ReadOnlyDeselectedSourceKeyList":[],
			"NoBackupSourceSelected":true,
			"PostCommandList":[],
			"LanUsername":"system",
			"ClientVersion":"",
			"LastUploadLogToServerTime":-1,
			"CloudFileSourceType":null,
			"TotalUploaded":0,
			"AllowedIPList":[
				{
					"ReadOnly":false,
					"StartIP":"0.0.0.0",
					"Id":"1703141906825",
					"EndIP":"255.255.255.255"
				}
			],
			"ModuleUsage":{
				"ModuleUsage":0,
				"HostCount":1
			},
			"DeduplicationSettings":{
				"MigrateData":false,
				"Scope":"ALL_FILES",
				"Enabled":true,
				"SettingsMigrated":false,
				"Id":"",
				"BlockSize":131072
			},
			"ApplicationSupportRunDirect":false,
			"@class":"com.ahsay.obx.cxp.obx.BackupSet",
			"RetentionPolicySettings":{
				"AdvancedRetentionPolicyList":[],
				"Type":"SIMPLE",
				"OverlapSensitive":false,
				"Period":7,
				"Id":"",
				"Unit":"DAYS"
			},
			"SubIndexType":false,
			"DefaultBSetSettings":{
				"Owner":"",
				"EnfBSe":false,
				"Category":"",
				"DefBSet":false,
				"Id":""
			},
			"DeltaType":"I",
			"Version7Checked":false,
			"ResolvedFromDefaultBset":false,
			"CompressType":"SnappyDefaultCompression",
			"Type":"Tibero Database Server",
			"LocalFilesBackup":true,
			"DisplayDestination":null,
			"LanDomain":"",
			"ShadowCopyEnabled":true,
			"LocalCopySettings":{
				"Zip":true,
				"DestinationPath":"",
				"SkipOffsiteBackup":false,
				"SetPermission":false,
				"Enabled":false,
				"LocalCopyRetentionPolicySettings":{
					"ReadOnly":false,
					"Enabled":false,
					"Period":7,
					"Id":"",
					"Unit":"DAYS"
				},
				"Id":""
			},
			"SettingsMigrated":false,
			"AllHostClientVersion":null,
			"SelectedSourceList":[]
		}
	}			
}

Example 2: Snippet of Deduplication Settings

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687505199600",
	"DestinationID":"1687505211240",
	"BackupJobID":"2024-06-23-15-27-57"
}

OUTPUT

{
	],
	"DeduplicationSettings":{
		"MigrateData":false,
		"Scope":"ALL_FILES",
		"Enabled":true,
		"SettingsMigrated":true,
		"Id":"",
		"BlockSize":65536
	},
}

Example 3: Snippet of Module Usage

INPUT

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

OUTPUT

{
	],
	"ModuleUsage":{
		"ModuleUsage":1,
		"ModuleType":"Office365Mail",
		"HostCount":1
	}
}
Documentation