Backup Set

This subcategory focuses on getting information regarding backup sets. Several functions can also performed using these APIs like adding, modifying and deleting backup sets as well as the details of the backup set.

• UpdateBackupSet (v1,v2)
• AddSelectSrc
• RemoveSelectSrc
• AddDeselectSrc
• RemoveDeselectSrc
• AddSchedule (v1,v2)
• UpdateSchedule (v1,v2)
• RemoveSchedule
• AddFilter
• UpdateFilter
• RemoveFilter
• RemoveBandwidthControl
• AddBackupSet
• AddAllowedIP
• RemoveAllowedIP
• DeleteBackupData
• DeleteBackupFile
• DeleteBackupSet
• GetBackupJobProgress
• GetBackupSet (v1,v2)
• ListBackupFiles
• ListBackupJobMode
• ListBackupJobs
• ListBackupJobStatus
• ListBackupSets
• RunBackup
• AddPreCommand
• UpdatePreCommand
• RemovePreCommand
• AddPostCommand
• UpdatePostCommand
• RemovePostCommand
• ListRestoreJobs
• ListRestoreJobStatus
• ListRestoreDrillJobs

UpdateBackupSet (v1,v2)

This API can be used to update settings of a backup set.

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

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

v1 UpdateBackupSet.do

URL

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

Deprecated Since Version: 7.15.6.38

v2 UpdateBackupSet.do

URL

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

Available Since Version: 9.5

Parameters

Return Values

JSON Objects

ReminderSettings

InFileDeltaSettings

WeeklyInFileDeltaSchedule

MonthlyInFileDeltaSchedule

LocalCopySettings

LocalCopyRetentionPolicySettings

RetentionPolicySettings

AdvancedRetentionPolicy

CdpSettings

CdpBackupControlSettings

BandwidthControlSettings

BandwidthControl

FilterSettings

FilterList

Pattern

ApplicationSettings

ScheduleSettings

DailyScheduleList

WeeklyScheduleList

MonthlyScheduleList

CustomScheduleList

Command

AllowedIP

DestinationSettings

Destination

NetworkAddress

RecycleBinSettings

DeduplicationSettings

Examples

Example 1: Updating a Microsoft 365 Online Destination

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687137085658",
	"ApplicationSettings":{
		"@class":"com.ahsay.obx.cxp.cloud.Office365ExchangeOnlineSettings",
		"RunOnServer":false,
		"Destination":{
			"@class":"com.ahsay.obx.cxp.obs.Office365ExchangeOnlineDestination",
			"Type":"Exchange",
			"Password":"",
			"DataMigrationMappingMergedToIndex":false,
			"MultiAccounts":true,
			"Username":"SampleAccount@ahsay.com",
			"DestinationKey":"OBS",
			"Id":"-1686815201815"
		}
	}
}

OUTPUT

{
	"Status":"OK"
}

Example 2: Updating an AhsayCBS Destination

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687138324430",
	"DestinationSettings":{
		"DestinationList":[
			{
				"Name":"CBS",
				"@class":"com.ahsay.obx.cxp.obs.ObsDestination",
				"Type":"OBS"
			}
		]
	}
}

OUTPUT

{
	"Status":"OK"
}

Example 3: Updating a Weekly In-File Delta Setting (v8 legacy backup set)

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687139082362",
	"InFileDeltaSettings":{
		"Enabled":true,
		"MinDeltaFileSize":"30",
		"MaxNumOfDelta":"200",
		"MaxDeltaRatio":"55",
		"DefaultDeltaType":"I",
		"WeeklyInFileDeltaSchedule":{
			"Day":["I","D","I","D","I","D","I"]
		}
	}
}

OUTPUT

{
	"Status":"OK"
}

Example 4: Updating a Monthly In-File Delta Setting (v8 legacy backup set)

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687139082362",
	"InFileDeltaSettings":{
		"Enabled":true,
		"MinDeltaFileSize":"30",
		"MaxNumOfDelta":"200",
		"MaxDeltaRatio":"55",
		"DefaultDeltaType":"I",
		"MonthlyInFileDeltaSchedule":{
			"Month":["D","I","D","I","D","I","D","I","D","I","D","I","D"],
			"Date":"3"
		}
	}
}

OUTPUT

{
	"Status":"OK"
}

Example 5: Recycle Bin Setup

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"ACB",
	"BackupSetID":"1692320086130",
	"RecycleBinSettings":{
		"Enabled":true,
		"RetentionPeriod":10
	}
}

OUTPUT

{
	"Status":"OK"
}

Example 6: Updating a Simple Retention Policy

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687139082362",
	"RetentionPolicySettings":{
		"Period":"3",
		"Type":"SIMPLE",
		"Unit":"JOBS"
	}
}

OUTPUT

{
	"Status":"OK"
}

Example 7: Updating an Advanced Daily Retention Policy

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687139082362",
	"RetentionPolicySettings":{
		"Type":"ADVANCED",
		"AdvancedRetentionPolicyList":[
			{
				"Id":"1687139082362",
				"Type":"DAILY",
				"NumbersToKeep":"3"
			}
		]
	}
}

OUTPUT

{
	"Status":"OK"
}

Example 8: Updating an Advanced Weekly Retention Policy

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687139082362",
	"RetentionPolicySettings":{
		"Period":"3",
		"Type":"ADVANCED",
		"Unit":"JOBS",
		"AdvancedRetentionPolicyList":[
			{
				"Id":"1687139082362",
				"Type":"WEEKLY",
				"NumbersToKeep":"3",
				"Mon":"true"
			}
		]
	}
}

OUTPUT

{
	"Status":"OK"
}

Example 9: Updating an Advanced Monthly Retention Policy

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687139082362",
	"RetentionPolicySettings":{
		"Type":"ADVANCED",
		"AdvancedRetentionPolicyList":[
			{
				"Id":"1687139082362",
				"Type":"MONTHLY",
				"Day":"12",
				"NumbersToKeep":"3"
			}
		]
	}
}

OUTPUT

{
	"Status":"OK"
}

Example 10: Updating an Advanced Custom Retention Policy

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687139082362",
	"RetentionPolicySettings":{
		"Type":"ADVANCED",
		"AdvancedRetentionPolicyList":[
			{
				"Id":"1687139082362",
				"Type":"CUSTOM",
				"Month":"6",
				"Day":"31",
				"Year":"2024"
			}
		]
	}
}

OUTPUT

{
	"Status":"OK"
}

Example 11: Updating a Bandwidth Control Setting

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687139082362",
	"BandwidthControlSettings":{
		"Enabled":true,
		"Mode":"Share",
		"BandwidthControlList":[
			{
				"Name":"ban1",
				"Id":"1687139082362",
				"MaxTransferRateInBitsPerSec":"25600000"
			}
		]
	}
}

OUTPUT

{
	"Status":"OK"
}

Example 12: Updating a Filter Setting

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687139082362",
	"FilterSettings":{
		"Enabled":true,
		"FilterList":[
			{
				"Name":"update",
				"@class":"com.ahsay.obx.cxp.obs.Filter",
				"Id":"1687142103157",
				"TopDir":"C:\\test",
				"ApplyToDir":false,
				"PatternList":[
					{
						"Pattern":".txt"
					},
					{
						"Pattern":".png"
					}
				]
			}
		]
	}
}

OUTPUT

{
	"Status":"OK"
}

Example 13: Updating a Daily Schedule and Custom Schedule Settings

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687139082362",
	"ScheduleSettings":{
		"Enabled":true,
		"DailyScheduleList":[
			{
				"Id":"1434946034621",
				"Hour":"12",
				"Minute":"30"
			}
		],
		"CustomScheduleList":[
			{
				"Id":"1687144789077",
				"Name":"Custom 1",
				"Hour":"6",
				"Minute":"30",
				"Date":"2024-06-19"
			}
		]
	}
}

OUTPUT

{
	"Status":"OK"
}

Example 14: Updating OpenDirect Settings

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687139082362",
	"EnableOpenDirect":false
}

OUTPUT

{
	"Status":"OK"
}

Example 15: Updating MariaDB Type Backup Sets

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687150109716",
	"ApplicationSettings":{
		"@class":"com.ahsay.obx.cxp.cloud.MariaDBSettings",
		"Username":"root",
		"Version":"",
		"Port":"3306",
		"Host":"10.16.10.88",
		"Id":"",
		"MysqldumpPath":"/"
	}
}

OUTPUT

{
	"Status":"OK"
}

Example 16: Deduplication (Incorrect Scope: "SAME_FILES")

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687150109716",
	"DeduplicationSettings":{
		"Scope":"SAME_FILES",
		"MigrateData":false,
		"Enabled":false,
		"SettingsMigrated":false,
		"Id":"",
		"BlockSize":262144
	}
}

OUTPUT

{
	"Status":"Error",
	"Message":"Cannot deserialize value of type ‘com.ahsay.obx.cxp.cloud.DeduplicationSettings$DeduplicationScope’ from String\”SAME_FILES\”: not one of the values accepted for Enum class: [ALL_FILES, SAME_FILE]\n at [Source: (String)\”{\Type\”:\”MariaDB\”, \”Timezone\”:\”1098\”, \”Delete\” :false, \”LoginName\”:\”obm\”, \”Owner\”:\”w2k16-std\”, \”DisplayOwner\”: \”w2k16-std\”, \”SysUser\”:\”system\”, \”Os\”:\”Windows Server 2016\”, \”RunBackupSettings\”:{\”DestiationIDList\”:[],\”Enabled\”:false, \”BackupType\”:\”\”, \”BackupJobID\”:\”\”, \”Id\”:\”\”}, \”RunOnServer\”: false, \”SelectedShortcutList\”:[],\”V6Passwords\”:{\”ApplicationPassword\”: \”\”,\”WinUserAuthPassword\”:\”\”,\”Id”\:\”\”},\"CdpSettings\":{\"@class\":\"com.ahsay.obx.cxp.obs.CdpSettings\",\"TimeMarkInterval\":30,\"CdpBackupControlSettings\":{\"Consi\"[truncated 6651 chars]; line: 1, column: 6343] (through reference chain: com.ahsay.obx.cxp.obs.BackupSet[\"DeduplicationSettings\"]->com.ahsay.obx.cxp.cloud.DeduplicationSettings[\"Scope\"])",
	"ExptType":"com.fasterxml.jackson.databind.exc.InvalidFormatException"
}

Example 17: Deduplication (Scope: "ALL_FILES")

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687150109716",
	"DeduplicationSettings":{
		"Scope":"ALL_FILES",
		"MigrateData":false,
		"Enabled":false,
		"SettingsMigrated":false,
		"Id":"",
		"BlockSize":262144
	}
}

OUTPUT

{
	"Status":"OK"
}

AddSelectSrc

This API can be used to add additional backup source to a backup set.

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% > Source

URL

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

Available Since Version: 9.1

Parameters

Return Values

JSON Objects

SourceBean

Examples

Example 1

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687137085658",
	"SelectedSrc":[
		{
			"Src":"C:\\New1"
		},
		{
			"Src":"C:\\New2\\data"
		}
	]
}

OUTPUT

{
	"Status":"OK"
}

Example 2: Input with incorrect escape character (e.g. C:\ instead of C:\\)

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687137085658",
	"SelectedSrc":[
		{
			"Src":"C:\New1"
		}
	]
}

OUTPUT

{
	"Status":"Error",
	"Message":"[Error] JSON Input Syntax is incorrect!",
	"ExptType":"java.lang.Exception"
}

Example 3: Input with incorrect escape character dividing sub-directory (e.g. \ instead of \\)

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687137085658",
	"SelectedSrc":[
		{
			"Src":"C:\\New2\data"
		}
	]
}

OUTPUT

{
	"Status":"OK"
}

RemoveSelectSrc

This API allows you to remove selected source from a backup set. Running that backup set again will no longer backup those files from the removed source.

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% > Source

URL

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

Available Since Version: 9.1

Parameters

Return Values

Examples

Example 1: Input (Single String)

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687137085658",
	"SelectedSrc":["Src":"C:\\New1"]
}

OUTPUT

{
	"Status":"OK"
}

Example 2: Input (Array of Strings)

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687137085658",
	"SelectedSrc":[
		{
			"Src":"C:\\New1"
		},
		{
			"Src":"C:\\New2\\data"
		}
	]
}

OUTPUT

{
	"Status":"OK"
}

AddDeselectSrc

This API allows you to add deselected source to a backup set. Running that backup set will no longer backup files from the deselected source.

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% > Source

URL

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

Available Since Version: 9.1

Parameters

Return Values

JSON Objects

SourceBean

Examples

Example 1

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687137085658",
	"DeselectedSrc":[
		{
			"Src":"C:\\New2"
		}
	]
}

OUTPUT

{
	"Status":"OK"
}

Example 2

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687137085658",
	"DeselectedSrc":[
		{
			"Src":"C:\\New2"
		},
		{
			"Src":"C:\\New1"
		}
	]
}

OUTPUT

{
	"Status":"OK"
}

RemoveDeselectSrc

This API allows you to remove deselected source from a backup set.

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% > Source

URL

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

Available Since Version: 9.1

Parameters

Return Values

Examples

Example 1: Input (Single String)

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687137085658",
	"Src":"C:\\New2"
}

OUTPUT

{
	"Status":"OK"
}

Example 2: Input (Array of String)

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687137085658",
	"Src":["Src":"C:\\New2", "Src":"C:\\New1"]
}

OUTPUT

{
	"Status":"OK"
}

AddSchedule (v1,v2)

This API creates a new backup schedule setting on a backup set.

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% > Backup Schedule

v1 AddSchedule.do

URL

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

Deprecated Since Version: 7.15.6.38

v2 AddSchedule.do

URL

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

Available Since Version: 9.1

Parameters

Return Values

JSON Objects

TimeBean

WeekSchedule

MonthSchedule

CustomSchedule

Examples

Example 1: Input Daily Schedule

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687137085658",
	"Name":"DAILYTEST",
	"Type":"DAILY",
	"BackupInterval":5,
	"FullBackup":true,
	"SpaceFreeUpEnabled":false,
	"SkipBackupEnabled":false
}

OUTPUT

{
	"Status":"OK"
}

Example 2: Input Weekly Schedule

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687137085658",
	"Name":"WEEKLYTEST",
	"Type":"WEEKLY",
	"BackupInterval":-1,
	"FullBackup":true,
	"Time":{
		"Hour":08,
		"Minute":00
	},
	"SpaceFreeUpEnabled":true,
	"SkipBackupEnabled":true,
	"WeekSchedule":{
		"Sun":true,
		"Mon":true,
		"Tue":true,
		"Wed":false,
		"Thu":false,
		"Fri":true,
		"Sat":true
	}
}

OUTPUT

{
	"Status":"OK"
}

Example 3: Input Incorrect Value for BackupInterval

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687137085658",
	"Name":"DAILYTEST",
	"Type":"DAILY",
	"BackupInterval":9,
	"FullBackup":true,
	"SpaceFreeUpEnabled":false,
	"SkipBackupEnabled":false
}

OUTPUT

{
	"Status":"Error",
	"Message":"ScheduleSettings parameter BackupInterval only can be -1 OR one of the following value: [1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30, 60, 120, 180,, 240, 480, 720]",
	"ExptType":"com.ahsay.obs.core.dbs.DbsException"
}

UpdateSchedule (v1,v2)

This API updates the backup schedule settings on a backup set. It will preserve existing values.

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% > Backup Schedule

v1 UpdateSchedule.do

URL

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

Deprecated Since Version: 7.15.6.38

v2 UpdateSchedule.do

URL

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

Available Since Version: 9.1

Parameters

Return Values

JSON Objects

TimeBean

WeekSchedule

MonthSchedule

CustomSchedule

Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687137085658",
	"ID":"1688116563583",
	"Name":"DAILYTEST",
	"Type":"DAILY",
	"FullBackup":true,
	"Time":{
		"Hour":21,
		"Minute":30
	},
	"SpaceFreeUpEnabled":true,
	"SkipBackupEnabled":true
}

OUTPUT

{
	"Status":"OK"
}

RemoveSchedule

This API removes a schedule from a backup set.

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% > Backup Schedule

URL

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

Available Since Version: 9.1

Parameters

Return Values

Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687137085658",
	"ID":"1688116563583"
}

OUTPUT

{
	"Status":"OK"
}

AddFilter

This API allows you to add filters to the backup source of a backup set. You can choose to include or exclude files which match a specific pattern.

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% > Source > Apply filters to the backup source

URL

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

Available Since Version: 9.1

Parameters

Return Values

JSON Objects

PatternBean

Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687137085658",
	"Name":"filter1",
	"TopDir":"C:\\test",
	"Type":"DEFAULT",
	"Include":false,
	"Only":true,
	"Apply2Dir":true,
	"Apply2File":true,
	"Patterns":[
		{
			"Pattern":".txt"
		},
		{
			"Pattern":".png"
		}
	]
}

OUTPUT

{
	"Status":"OK"
}

UpdateFilter

This API update the settings of a filter from a backup set.

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% > Source > Apply filters to the backup source

URL

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

Available Since Version: 9.1

Parameters

Return Values

JSON Objects

PatternBean

Examples

Example 1: Update the name

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687137085658",
	"ID":"1687499274011",
	"Name":"filter2updated"
}

OUTPUT

{
	"Status":"OK"
}

Example 2: Update pattern

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687137085658",
	"ID":"1687499274011",
	"Name":"testupdated",
	"Patterns":[
		{
			"Pattern":".txt123"
		},
		{
			"Pattern":".png123"
		}
	]
}

OUTPUT

{
	"Status":"OK"
}

RemoveFilter

This API allows you to remove a filter from a backup set.

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% > Source > Apply filters to the backup source

URL

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

Available Since Version: 9.1

Parameters

Return Values

Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687137085658",
	"ID":"1687499274011"
}

OUTPUT

{
	"Status":"OK"
}

RemoveBandwidthControl

This API can be used to remove a bandwidth control setting from a backup set.

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% > Bandwidth Control

URL

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

Available Since Version: 9.1

Parameters

Return Values

Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687137085658",
	"ID":"1687500432855"
}

OUTPUT

{
	"Status":"OK"
}

AddBackupSet

This API allows you to create a new backup set for a user.

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

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

URL

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

Available Since Version: 9.1

Parameters

Return Values

JSON Objects

Destination

Examples

Example 1

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetName":"Test_Name",
	"BackupSetType":"Cloud File",
	"EncryptionType":"DEFAULT",
	"Length":"128",
	"Key":"123456",
	"Platform":"windows",
	"RunOnServer":false,
	"CloudFileType":"GDrive",
	"CloudBackupSourceSettings":{
		"Token":"4/0AeaYSHDXuv7rofdyAc20-g1Xoy4YoYite1Auly8NJA84CIGHtlmY9CSZ2ubfTN1N7pFqwQ"
	}
}

OUTPUT

{
	"Status":"OK",
	"BackupSetID":"1687501131522"
}

Example 2: CloudFileType parameter is missing

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetName":"API Cloud File Invalid",
	"BackupSetType":"Cloud File",
	"EncryptionType":"DEFAULT",
	"Length":"128",
	"Key":"hash",
	"Platform":"windows",
	"RunOnServer":false
}

OUTPUT

{
	"Status":"Error",
	"Message":"[Error] Invalid Platform. Please specify one of the following: windows / mac / linux",
	"ExptType":"java.lang.Exception"
}

Example 3: Wrong platform for backup set type

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetName":"Test_Name",
	"BackupSetType":"Tibero Database Server",
	"Platform":"mac",
	"DestinationList":[
		{
			"Name":"AhsayCBS",
			"Type":"OBS"
		}
	]
}

OUTPUT

{
	"Status":"Error",
	"Message":"[Error]Backup set type ‘Tibero Database Server’ is not supported on platform ‘mac’",
	"ExptType":"java.lang.Exception"
}

AddAllowedIP

This API allows you to add a range of IP of users which are allowed to perform restore in their computers.

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% > IP Allowed for Restore

URL

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

Available Since Version: 9.1

Parameters

Return Values

JSON Objects

AllowedIPBean

Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687501131522",
	"NewAllowedIP":{
		"StartIP":"1.1.1.1",
		"EndIP":"255.255.255.255"
}

OUTPUT

{
	"Status":"OK"
}

RemoveAllowedIP

This API allows you to remove an IP range from the allowed IP list. Users whose IP is not in the allowed IP list are not able to perform restore in their computers.

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% > IP Allowed for Restore

URL

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

Available Since Version: 9.1

Parameters

Return Values

Example

INPUT

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

OUTPUT

{
	"Status":"OK"
}

DeleteBackupData

This API only works for backups from version 6 or older backup clients.

URL

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

Available Since Version: 9.1

Parameters

Return Values

DeleteBackupFile

This API only works for backups from version 6 or older backup clients.

URL

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

Available Since Version: 9.1

Parameters

Return Values

DeleteBackupSet

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

Return Values

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"
}

GetBackupJobProgress

This API can be used to retrieve current progress of a backup job.

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

• Monitoring > Backup / Restore Logs > Backup Jobs

URL

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

Available Since Version: 9.1

Parameters

Return Values

JSON Objects

Record

Example

INPUT

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

OUTPUT

{
	"Status":"OK",
	"Data":{
		"BackupSetName":"default-backup-set-name-1",
		"LoginName":"obm",
		"Owner:"",
		"EndTime":"2024-06-23 15:29:37",
		"TotalFileCount":"70",
		"StartTime":"2024-06-23 15:28:16",
		"BackupSetID":"1687505199600",
		"UserID":"obm",
		"UploadedFileSize":"70479290",
		"CurrentFileName":"C:\\Users\\ahsay\\Desktop\\file_sample.exe",
		"TotalFileSize":"78477452",
		"ID":"2024-06-23-15-27-57",
		"CurrentFileCount":"0"
}

GetBackupSet (v1,v2)

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

Return Values

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[])

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

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

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

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

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

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

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

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

ModuleUsage

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
	}
}

ListBackupFiles

This API only works for backup data backed up by version 6 or older backup clients.

URL

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

Available Since Version: 9.1

Parameters

Return Values

JSON Objects

Backup File

Example

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
		}
	]
}

ListBackupJobMode

This API can be used to list all backup job information at a specific date.

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

• Monitoring > Backup / Restore Logs > Backup Jobs

URL

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

Available Since Version: 9.1

Parameters

Return Values

JSON Objects

Record

Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupDate":"2024-06-26-11-33-52"
}

OUTPUT

{
	"Status":"OK",
	"Data":[
		{
			"BackupSetName":"v6 File Backup",
			"LoginName":"obm",
			"Owner":"",
			"EndTime":"2024-06-26 11;34:15",
			"UserId":"obm",
			"StartTime":"2024-06-26 11:33:52",
			"BackupJobMode":"M",
			"BackupSetID":"1687750405259"
		}
	]
}

ListBackupJobs

This API can be used to show the basic information of all backup jobs performed by a specific user.

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

• Monitoring > Backup / Restore Logs > Backup Jobs

URL

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

Available Since Version: 9.1

Parameters

Return Values

JSON Objects

Backup Set

Example

INPUT

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

OUTPUT

{
	"Status":"OK",
	"Data":[
		{
			"BackupJob":[
				"2024-06-26-11-33-52"
			],
			"BackupSetID":"1687750405259",
			"Removed":false
		}
	]
}

ListBackupJobStatus

This API can be used to show detailed information such as destination ID and job status of all backup jobs performed by a specific user on a specific date.

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

• Monitoring > Backup / Restore Logs > Backup Jobs

URL

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

Available Since Version: 9.1

Parameters

Return Values

JSON Objects

Record

Examples

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"Owner":"",
	"LoginName":"ACB",
	"BackupDate":"2024-08-16"
}

OUTPUT

{
	"Status":"Error",
	"Data":[
		{
			"BackupJobStatus":"BS_STOP_BY_USER",
			"BackupSetName":"TEST 1",
			"LoginName":"ACB",
			"Owner":"",
			"MissedDatabase":"",
			"EndTime":"2024-28-16 14:06:33",
			"SuccessDatabase":"",
			"SuccessPublicFolder":"",
			"StartTime":"2024-08-16 14:06:18"
			"BackupSetID":"1692164297907",
			"MissedPublicFolder":"",
			"DestinationID":"1692164297907",
			"UserID":"ACB",
			"UploadSize":0,
			"RunVersion":"9.7.0.0",
			"ID":"2024-08-16-14-16-17
		}
	]
}

ListBackupSets

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

Return Values

JSON Objects

Backup Set

ModuleUsage

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
	}
}

RunBackup

This API can be used to start a backup for a specific user or to cancel a pending backup job from the server initiated backup job list.

URL

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

Available Since Version: 9.1

Parameters

Return Values

Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"username",
	"BackupSetID":"1462518403716"
}

OUTPUT

{
	"Status":"OK"
}

AddPreCommand

This API can be used to add a pre-backup command to a backup set.

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% > Command Line Tool

URL

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

Available Since Version: 9.1

Parameters

Return Values

Examples

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687755057644",
	"Name":"test,
	"WorkingDir":"test",
	"Command":"test"
}

OUTPUT

{
	"Status":"OK"
}

UpdatePreCommand

This API can be used to update a pre-backup command of a backup set.

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% > Command Line Tool

URL

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

Available Since Version: 9.1

Parameters

Return Values

Examples

Example 1: Update name

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687755057644",
	"ID":"1687755342349",
	"Name":"newname"
}

OUTPUT

{
	"Status":"OK"
}

Example 2: Update command content

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687755057644",
	"ID":"1687755342349",
	"Command":"newcommand"
}

OUTPUT

{
	"Status":"OK"
}

Example 3: Update working directory

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687755057644",
	"ID":"1687755342349",
	"WorkingDir":"newworkingdir"
}

OUTPUT

{
	"Status":"OK"
}

RemovePreCommand

This API can be used to remove a pre-backup command from a backup set.

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% > Command Line Tool

URL

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

Available Since Version: 9.1

Parameters

Return Values

Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687755057644",
	"ID":"1687755342349"
}

OUTPUT

{
	"Status":"OK"
}

AddPostCommand

This API can be used to add a post-backup command to a backup set.

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% > Command Line Tool

URL

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

Available Since Version: 9.1

Parameters

Return Values

Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687755057644",
	"Name":"test2,
	"WorkingDir":"test2",
	"Command":"test2"
}

OUTPUT

{
	"Status":"OK"
}

UpdatePostCommand

This API can be used to update a post-backup command of a backup set.

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% > Command Line Tool

URL

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

Available Since Version: 9.1

Parameters

Return Values

Examples

Example 1: Update name

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687755057644",
	"ID":"1687756006432",
	"Name":"newname"
}

OUTPUT

{
	"Status":"OK"
}

Example 2: Update command content

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687755057644",
	"ID":"1687756006432",
	"Command":"newcommand"
}

OUTPUT

{
	"Status":"OK"
}

Example 3: Update working directory

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687755057644",
	"ID":"1687756006432",
	"WorkingDir":"newworkingdir"
}

OUTPUT

{
	"Status":"OK"
}

RemovePostCommand

This API can be used to remove a post-backup command from a backup set.

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% > Command Line Tool

URL

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

Available Since Version: 9.1

Parameters

Return Values

Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687755057644",
	"ID":"1687756006432"
}

OUTPUT

{
	"Status":"OK"
}

ListRestoreJobs

This API can be used to list all restore jobs of each backup set owned by specified users.

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

• Monitoring > Backup / Restore Logs > Restore Jobs

URL

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

Available Since Version: 9.1

Parameters

Return Values

JSON Objects

Data

Example

INPUT

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

OUTPUT

{
	"Status":"OK",
	"Data":[
		{
			"RestoreJob":[
				"2024-06-26-13-25-13"
			],
			"BackupSetID":"1687755057644",
			"Removed":false
		}
	]
}

ListRestoreJobStatus

This API can be used to list restore job status of a specified user on a particular date.

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

• Monitoring > Backup / Restore Logs > Restore Jobs

URL

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

Available Since Version: 9.1

Parameters

Return Values

JSON Objects

Data

Examples

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"RestoreDate":"2024-06-26"
}

OUTPUT

{
	"Status":"OK",
	"Data":[
		{
			"Status":"RESTORE_STOP_SUCCESS",
			"BackupSetName":"default-backup-set-name-1",
			"LoginName":"obm",
			"Owner":"",
			"EndTime":"2024-06-26 13:25:21",
			"UserId":"obm",
			"RunVersion":"9.11.0.0",
			"StartTime":"2024-06-26 13:25:14",
			"ID":"2024-06-26-13-25-13",
			"BackupSetID":"1687755057644",
			"RestoreSize":0,
			"DestinationID":"1687755083984"
		}
	]
}

ListRestoreDrillJobs

This API can be list all completed restore drill jobs owned by a specified user.

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

• Monitoring > Backup / Restore Logs > Restore Drill Jobs

URL

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

Available Since Version: 9.9

Parameters

Return Values

JSON Objects

Data

Example

INPUT

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

OUTPUT

{
	"Status":"OK",
	"Data":[
		{
			"RestoreDrillJob":"2024-10-16-10-28-01",
			"BackupSetID":"1697422994935",
			"DestinationID":"1697423083118"
		},
		{
			"RestoreDrillJob":"2024-10-16-10-30-06",
			"BackupSetID":"1697422994935",
			"DestinationID":"1697423083118"
		}
	]
}