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

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	Obtainable by calling the ListBackupsets API.
RecycleBinSettings	JSON Object	See RecycleBinSettings.
ReadOnly	Boolean	True / False
Class	String	com.ahsay.obx.cxp.obs.BackupSet
Name	String	Name of the backup set.
ShadowCopyEnabled	Boolean	Enable Windows Volume Shadow Copy for open file backup.
DeleteTempFile	String	Remove temporary files after backup.
LogRetentionDays	Integer	Number of days to keep the backup set log.
FollowLink	Boolean	Follow link of the backup files.
CompressType	String	Type of compression, can be one of the following: GzipBestSpeedCompression (Fast), GzipDefaultCompression (Normal) or SnappyDefaultCompression (Fast with optimization for local). Default to 'No Compression" if not provided.
LanDomain	String	Windows User Authentication domain/hostname.
LanUsername	String	Windows User Authentication username.
LanPassword	String	Windows User Authentication user password.
WorkingDir	String	Temporary directory for storing backup files.
UploadPermission	Boolean	Enable to backup permission attribute of files.
ReminderSettings	Array	Array list of Reminder settings.
InFileDeltaSettings	Array	Array list of In-File Delta settings.
LocalCopySettings	Array	Array list of Local Copy settings.
RetentionPolicySettings	Array	Array list of Retention Policy settings.
CdpSettingsV6	Array	Array list of CDP settings for v6.
CdpSettingsV7	Array	Array list of CDP settings for v7.
BandwidthControlSettings	Array	Array list of Bandwidth Control settings.
FilterSettings	Array	Array list of Filter settings.
ScheduleSettings	Array	Array list of Schedule settings.
DestinationSettings	Array	Array list of Destination settings.
SelectedSourceList	Array	Can be an array with local path (String type) and network address with credential (NetworkAddress type).
DeselectedSourceList	Array	Can be an array with local path (String type) and network address with credential (NetworkAddress type).
PreCommandList	Array	Array list of pre commands.
PostCommandList	Array	Array list of post commands.
AllowedIPList	Array	Array list of allowed IPs for restore.
ApplicationSettings	Array	Array list of Application settings.
DestinationList	Array	Array list of Destinations (optional).
EnableOpenDirect	Boolean	Cannot be changed once set.
NetworkAddress	JSON Object	Can be used in SelectedSourceList and DeselectedSourceList.
DeduplicationSettings	Object	Refer to DeduplicationSettings.

Return Values

Key	Type	Description
Status	String	"OK" or "Error"
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

ReminderSettings

Key	Type	Description
ReadOnly	Boolean	True / False
BackupIntervalHours	Integer	Backup interval in hours, 00-23.
OfflineNotificationDay	Integer	This setting is only applicable for v6 legacy backup user.
OfflineBackupEnabled	Boolean	On-Off for offline backup reminder.
BackupIntervalDay	Integer	Backup Interval in days, 00-31.
ShowOfflineBackupReminder	Boolean	This settings only applicable for v6 legacy backup user.
LogoutBackupReminderEnabled	Boolean	Enable/Disable backup reminder when Windows log off or shutdown.
OfflineBackupReminderComputerName	String	The computer name for the offline backup reminder.
LogoutBackupReminderComputerName	String	The computer name for the logout backup reminder.

InFileDeltaSettings

Key	Type	Description
Enabled	Boolean	True / False
ReadOnly	Boolean	True / False
MinDeltaFileSize	Long	Only apply In-File Delta to files larger than this size.
MaxNumOfDelta	Long	Upload full file when number of deltas are over this number.
MaxDeltaRatio	Long	Upload full file when delta file size / full file size is over this ratio. It can only be multiple of 5 and maximum of 100.
DefaultDeltaType	String	Type of delta, can either be I or D.
WeeklyInFileDeltaSchedule	Array	Weekly variations for overriding default type.
MonthlyInFileDeltaSchedule	Array	Monthly variations for overriding default type.

WeeklyInFileDeltaSchedule

Key	Type	Description
ReadOnly	Boolean	True / False
Day	Array	The array contains 7 Strings which corresponds to the delta type from Sunday to Saturday. "I" for incremental delta on that day, "D" for differential delta on that day and "" for full backup on that day.

MonthlyInFileDeltaSchedule

Key	Type	Description
ReadOnly	Boolean	True / False
Month	Array	The array contains 12 Strings which corresponds to the delta type from January to December. "I" for incremental delta on that day, "D" for differential delta on that day and "" for full backup on that day.
Date	Integer	Day of selected months in yearly variations.
Criteria	String	The value can be one of the following: Weekday, Weekend, Sunday, Monday, Tuesday, Wednesday, Thursday, Friday and Saturday.
Occurrence	String	The value can be one of the following: First, Second, Third, Fourth and Last.

LocalCopySettings

Key	Type	Description
ReadOnly	Boolean	True / False
Enabled	Boolean	This setting only applicable for v6 legacy backup users.
DestinationPath	String	This setting only applicable for v6 legacy backup users.
SetPermission	Boolean	This setting only applicable for v6 legacy backup users.
SkipOffsiteBackup	Boolean	This setting only applicable for v6 legacy backup users.
LocalCopyRetentionPolicySettings	Array	This setting only applicable for v6 legacy backup users.
Zip	Boolean	This setting only applicable for v6 legacy backup users.

LocalCopyRetentionPolicySettings

Key	Type	Description
ReadOnly	Boolean	True / False
Enabled	Boolean	This setting only applicable for v6 legacy backup users.
Period	Integer	This setting only applicable for v6 legacy backup users.
Unit	String	This setting only applicable for v6 legacy backup users.

RetentionPolicySettings

Key	Type	Description
ReadOnly	Boolean	True / False
Period	Integer	Keep the deleted files for this number of days.
OverlapSensitive	Boolean	True / False
Type	String	Type of retention policy, either SIMPLE or ADVANCED.
Unit	String	Unit of retention policy, either DAYS or JOBS.
AdvancedRetentionPolicy	Array	Array list of Advanced Retention Policies.

AdvancedRetentionPolicy

Key	Type	Description
ReadOnly	Boolean	True / False
Id	Long	ID of the retention policy to update.
Type	String	Type of advanced retention policy. The value can be one of the following: DAILY, WEEKLY, MONTHLY, QUARTERLY, YEARLY or CUSTOM.
NumbersToKeep	Integer	Available to change when you choose the following type: DAILY, WEEKLY, MONTHLY, QUARTERLY or YEARLY.
Day	Integer	Available to change when you choose the following type: DAILY, WEEKLY, MONTHLY, QUARTERLY or YEARLY.
Week	Integer	Available to change when you choose the following type: DAILY, WEEKLY, MONTHLY, QUARTERLY or YEARLY.
Month	Integer	Available to change when you choose the following type: DAILY, WEEKLY, MONTHLY, QUARTERLY or YEARLY.
Year	Integer	Available to change when you choose CUSTOM for the type.
DateType	String	It can be empty for daily or weekly retention policy, or one of the following: WEEK_OF_MONTH, WEEK_OF_YEAR or EXACT.
Sun, Mon, Tue, Wed, Thu, Fri, Sat	Boolean	For weekly custom retention policy.

CdpSettings

Key	Type	Description
ReadOnly	Boolean	True / False
Enable	Boolean	True / False
Type	String	For CdpSettingsV6, the value can be one of the following: all-volume, backup-source or custom-source. For CdpSettingsV7, the value is all-volume.
BackupType	String	The value can be empty or one of the following: DATABASE, DIFFERENTIAL, LOG, SKIP or POWEROFF. For Oracle and Lotus Domino backup sets, the value must be DATABASE or LOG. For MS SQL Server backup sets, the value must be DATABASE or DIFFERENTIAL For MS Exchange Server before 2007 and ShadowProtect backup sets, the value must be DATABASE, DIFFERENTIAL or LOG. For MS Exchange Server 2007 or above, the value must be DATABASE or LOG. For VMware backup sets, if version is VMware Server 1 or VMware Player, the value must be SKIP or POWEROFF.
MinUpdateInterval	Integer	Update intervals.
TimeMarkInterval	Integer	Mark intervals.
MaxFileSize	Integer	Only apply to files smaller than 20, 50, 100, 500, 1000 or unlimited.
ComputerName	String	Run CDP on these computers.
ExcludeSystemFiles	Boolean	True / False
FilterList	Array	Array list of Filters.
Version	String	For CdpSettingsV7, the value is 7.
CdpBackupControlSettings	Array	This setting is only applicable for v6 legacy backup users.
SelectedSourceList	Array	Array list of selected sources.
Id	Array	V6 for CdpSettingsV6 and V7 for CdpSettingsV7.

CdpBackupControlSettings

Key	Type	Description
ReadOnly	Boolean	True / False
ConsiderCpuUsage	Boolean	This setting is only applicable for v6 legacy backup users.
CpuUsage	Integer	This setting is only applicable for v6 legacy backup users.
ConsiderInput	Boolean	This setting is only applicable for v6 legacy backup users.
ObserveInputForSecond	Integer	This setting is only applicable for v6 legacy backup users
ConsiderNetworkTraffic	Boolean	This setting is only applicable for v6 legacy backup users.
NetworkTraffic	Long	This setting is only applicable for v6 legacy backup users

BandwidthControlSettings

Key	Type	Description
ReadOnly	Boolean	True / False
Enabled	Boolean	True / False
BandwidthControlList	Array	Array list of Bandwidth Controls.
Mode	String	Mode of bandwidth, which can either be independent or share.

BandwidthControl

Key	Type	Description
ReadOnly	Boolean	True / False
Name	String	Name of bandwidth control setting.
Id	Long	ID of bandwidth control setting.
MaxTransferRateInBitsPerSec	Long	Maximum allowable transfer rate.
StartDay	Integer	Starting day of bandwidth control.
StartHour	Integer	Starting hour of bandwidth control.
StartMinute	Integer	Starting minute of bandwidth control.
EndDay	Integer	Ending day of bandwidth control.
EndHour	Integer	Ending hour of bandwidth control.
EndMinute	Integer	Ending minute of bandwidth control.

FilterSettings

Key	Type	Description
ReadOnly	Boolean	True / False
Enabled	Boolean	True / False
FilterList	Array	Array list of Filters.

FilterList

Key	Type	Description
ReadOnly	Boolean	True / False
Name	String	Name of the filter.
Id	Long	ID of the filter, obtainable in GetBackupSet API.
TopDir	String	Apply filter to a specific directory only.
@class	String	com.ahsay.obx.cxp.obs.Filter
ApplyToDir	Boolean	Apply filters to directory.
Type	String	Type of filter, the value can be one of the following: START_WITH, END_WITH, CONTAIN or CUSTOM.
Include	Boolean	Either include or exclude matched files/folder under the top directory.
Only	Boolean	If set to true, it will not include all unmatched files/folders. If set to false, it will include all unmatched files/folders.
PatternList	Array	Array list of patterns.
MatchPatternAgainstFullPathOnly	Boolean	True / False
Username	String	Username of UNC paths with non-Windows credentials as backup source.
Password	String	Password of UNC paths with non-Windows credentials as backup source.

Pattern

Key	Type	Description
ReadOnly	Boolean	True / False
Pattern	String	Details of pattern.

ApplicationSettings

Key	Type	Description
ReadOnly	Boolean	True / False
@class	String	Classification of application.
Id	String	ID of application setting.
Version	String	Version of application setting.
WindowsOutlook	Boolean	Backup source shortcut to Outlook. Applicable for File backup set only.
WindowsDesktop	Boolean	Backup source shortcut to Desktop. Applicable for File backup set only.
WindowsOutlookExpress	Boolean	Backup source shortcut to Outlook Express. Applicable for File backup set only.
WindowsMail	Boolean	Backup source shortcut to Windows Mail. Applicable for File backup set only.
WindowsFavourites	Boolean	Backup source shortcut to Favourites. Applicable for File backup set only.
WindowsMyDocuments	Boolean	Backup source shortcut to My Documents. Applicable for File backup set only.
NotesIniPath	String	Path to notes.ini. Applicable for IBM Lotus Domino / IBM Lotus Notes backup set only.
BackupSystemState	Boolean	Applicable for Windows System State backup set only.
LoginID	String	Login ID of sa / system account. Applicable for MS SQL Server / MySQL / Oracle Database Server / MariaDB / VMware / PostgreSQL backup set only.
Password	String	Password of sa / system / root account. Applicable for MS SQL Server / MySQL / Oracle Database Server / MariaDB / VMware / PostgreSQL backup set only.
Server	String	SQL Server instance. Applicable for MS SQL Server backup set only.
BackupTarget	String	Temporary storage location of the MS Windows System / System State backup set. Applicable for MS Windows System / System State backup set only.
HostType	String	Host type of MySQL / MariaDB / PostgreSQL. Applicable for MySQL / MariaDB Database Server / PostgreSQL backup set only.
Port	Integer	Listening port of the MySQL / Oracle Database Server. Port to the VMware hypervisor. Applicable for MySQL / Oracle / MariaDB Database Server / VMware / PostgreSQL backup set only.
Host	String	Hostname or IP to MySQL / Oracle Database Server / MariaDB / VMware hypervisor / PostgreSQL. Applicable for MySQL / Oracle / MariaDB Database Server / VMware / PostgreSQL backup set only.
Username	String	Username of root account. Applicable for MySQL / MariaDB Database Server / VMware / PostgreSQL backup set only.
MysqldumpPath	String	Path to the mysqldump file. Applicable for MySQL / MariaDB Database Server backup set only.
PostgreSQLDumpPath	String	Path to the postgresqldump file. Applicable for PostgreSQL Server backup set only.
LastArchivedLogName	String	Applicable for Oracle Database Server backup set only.
Sid	String	Oracle SID. Applicable for Oracle Database Server backup set only.
EncryptionAlgorithm	String	Applicable for ShadowProtect System backup set only.
EncryptionPassword	String	Applicable for ShadowProtect System backup set only.
InstallLocation	String	Applicable for ShadowProtect System backup set only.
Sshport	Integer	Applicable for VMware backup set only.
AutoEnableCBT	Boolean	Applicable for VMware backup set only.
OneDrive	Boolean	Applicable for Microsoft 365 backup set only.
PublicFolders	Boolean	Applicable for Microsoft 365 backup set only.
SiteCollections	Boolean	Applicable for Microsoft 365 backup set only.
Outlook	Boolean	Applicable for Microsoft 365 backup set only.

ScheduleSettings

Key	Type	Description
ReadOnly	Boolean	True / False
Enable	Boolean	True / False
ComputerName	String	Name of computer.
DailyScheduleList	Array	Array list of Daily Schedules.
WeeklyScheduleList	Array	Array list of Weekly Schedules.
MonthlyScheduleList	Array	Array list of Monthly Schedules.
CustomScheduleList	Array	Array list of Custom Schedules.

DailyScheduleList

Key	Type	Description
ReadOnly	Boolean	True / False
Name	String	Name of the schedule.
Id	Long	ID of the schedule, obtainable in GetBackupSet API.
Hour	Integer	The hour when the backup will start, refer to HH.
Minute	Integer	The minute when the backup will start, refer to MM.
Duration	Integer	(optional) If no value is specified, default value=-1. The value can either be 'until full backup completed =-1' or 'stop backup after xx hours=1 to 24'.
BackupType	String	Type of backup. Can be empty or one of the following: DATABASE, DIFFERENTIAL, LOG, SKIP or POWEROFF. For Oracle and Lotus Domino backup sets, the value must be DATABASE or LOG. For MS SQL Server backup sets, the value must be DATABASE or DIFFERENTIAL. For MS Exchange Server 2007 or above, the value must be DATABASE or LOG. For MS Exchange Server 2007 or above, the value must be DATABASE or LOG. For VMware backup sets, if version is VMware Server 1 or VMware Player, the value must be SKIP or POWEROFF.
SpaceFreeUpEnabled	Boolean	Remove obsolete files from backup destination according to retention policy.
LastUpdateTime	Long	Time of last update.
@class	String	com.ahsay.obx.cxp.obs.DailySchedule
MigratedFromCdp	Boolean	If true it indicates it is migrated from CDP, this value cannot be changed.
BackupInterval	Integer	For periodic backup schedule the value can be -1 or one of the following: 1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30, 60, 120, 180, 240, 360, 480 or 720. (-1 means periodic schedule is disabled, that it is a normal schedule)

WeeklyScheduleList

Key	Type	Description
ReadOnly	Boolean	True / False
Name	String	Name of the schedule.
Id	Long	ID of the schedule, obtainable in GetBackupSet API.
Hour	Integer	The hour when the backup will start, refer to HH.
Minute	Integer	The minute when the backup will start, refer to MM.
Duration	Integer	(optional) If no value is specified, default value=-1. The value can either be 'until full backup completed =-1' or 'stop backup after xx hours=1 to 24'.
BackupType	String	Refer to BackupType of DailySchedule.
Days	Array	The array contains 7 boolean values that correspond to Sunday until Saturday. If the boolean value is true, backup will be run on that day.
SpaceFreeUpEnabled	Boolean	Remove obsolete files from backup destination according to retention policy.
LastUpdateTime	Long	Time of last update.
@class	String	com.ahsay.obx.cxp.obs.WeeklySchedule
MigratedFromCdp	Boolean	If true it indicates it is migrated from CDP, this value cannot be changed.
BackupInterval	Integer	Refer to BackupInterval of DailySchedule.

MonthlyScheduleList

Key	Type	Description
ReadOnly	Boolean	True / False
Name	String	Name of the schedule.
Id	Long	ID of the schedule, obtainable in GetBackupSet API.
Hour	Integer	The hour when the backup will start, refer to HH.
Minute	Integer	The minute when the backup will start, refer to MM.
Duration	Integer	(optional) If no value is specified, default value=-1. The value can either be 'until full backup completed =-1' or 'stop backup after xx hours=1 to 24'.
BackupType	String	Refer to BackupType of DailySchedule.
Occurence	String	The value can be one of the following: First, Second, Third, Fourth or Last.
Criteria	String	The value can be one of the following: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Weekday or Weekend.
SpaceFreeUpEnabled	Boolean	Remove obsolete files from backup destination according to retention policy.
LastUpdateTime	Long	Time of last update.
@class	String	com.ahsay.obx.cxp.obs.MonthlySchedule

CustomScheduleList

Key	Type	Description
ReadOnly	Boolean	True / False
Name	String	Name of the schedule.
Id	Long	ID of the schedule, obtainable in GetBackupSet API.
Hour	Integer	The hour when the backup will start, refer to HH.
Minute	Integer	The minute when the backup will start, refer to MM.
Duration	Integer	(optional) If no value is specified, default value=-1. The value can either be 'until full backup completed =-1' or 'stop backup after xx hours=1 to 24'.
Date	String	The date when backup will be performed, in yyyy-MM-dd format.
BackupType	String	Refer to BackupType of DailySchedule.
SpaceFreeUpEnabled	Boolean	Remove obsolete files from backup destination according to retention policy.
LastUpdateTime	Long	Time of last update.
@class	String	com.ahsay.obx.cxp.obs.CustomSchedule

Command

Key	Type	Description
ReadOnly	Boolean	True / False
Name	String	Name of the command.
Command	String	Specifics of the command.
Type	String	Type of command, can either be Pre or Post.
Id	Long	ID of the command, obtainable in GetBackupSet API.
WorkingDir	String	Directory where the command will be applied.
Username	String	Username used in the UNC path with non-Windows credentials as backup source.
Password	String	Password used in the UNC path with non-Windows credentials as backup source.

AllowedIP

Key	Type	Description
ReadOnly	Boolean	True / False
Id	Long	ID of the allowed IP.
StartIP	String	Starting value of allowable IPs.
EndIP	String	Ending value of allowable IPs.

DestinationSettings

Key	Type	Description
ReadOnly	Boolean	True / False
DestinationList	Array	Array list of Destinations.

Destination

Key	Type	Description
ReadOnly	Boolean	True / False
Id	Long	ID of the destination, obtainable in GetBackupSet API.
Name	String	Name of the destination.
TopDir	String	Top directory.
@class	String	Destination classification
Type	String	Backup destination type which can be one of the following: Local, CloudDrive, S3, AWSCompatib.e, Wasabi, Backblaze, GCS, GDrive, Azure, OneDrive, OpenStack, Rackspace, Dropbox, FTP, SFTP, OBS, Pooled, Aliyun and Exchange.
UserName	String	Username used to login to the destination.
Password	String	Password used to login to the destination.
HostName	String	Hostname or IP of the destination.
Port	String	Port used by the destination.
AccessKey	String	Access key used by the destination.
Location	String	Location used by the destination.
DestinationKey	String	Destination key used by the destination.
Secret	String	Secret used by the destination.
UserID	String	User ID used by the destination.
Token	String	Token used by the destination.
ClientID	String	Client ID used by the destination.
UserDisplayName	String	User display name shown by the destination.
ClientSecret	String	Client secret used by the destination.
Region	String	Region of the destination.
TenantID	String	Tenant ID of the destination.
AppFolderName	String	Application folder name of the destination.
UsingSSL	Boolean	True / False
UsingProxy	Boolean	True / False
DestinationList	Array	Array list of Destinations.

NetworkAddress

Key	Type	Description
Src	String	Source
Username	String	Username used to login.
Password	String	Password used to login.

RecycleBinSettings

Key	Type	Description
Enabled	Boolean	Enable moving the files to the Recycle Bin when remove file from Retention Policy or DIC.
RetentionPeriod	Integer	Number of days the files will be kept in the recycle bin.
Id	String	Not used.

DeduplicationSettings

Key	Type	Description
Enabled	Boolean	Whether deduplication is enabled.
Scope	String	Scope of the deduplication, either SAME_FILE or ALL_FILES. Other value will result in error.
BlockSize	Integer	Size of the block, can be one of the following: 65536 for 64k-256k, 131072 for 128k-512k, 262144 for 256k-1M, 524288 for 512k-2M or 1048576 for 1M-4M. Removed in v9.5 "-1" (for "Auto" which is the default choice in earlier v9).
SettingsMigrated	Boolean	Whether the settings will be migrated from In-File Delta settings during the next profile update.
MigrateData	Boolean	Whether to migrate data for pre-v9 In-File Delta to v9 deduplication during backup.
Id	String	Not used.

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":{
		"HostType": "SELF_HOSTED",
		"@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"
}