Skip to main content

UpdateServerConfig (v1), UpdateSystemSettings (v2) - Backup Server

July 21, 2025

This API can be used to update Backup Server related configuration such as the User Home and Free Trial user registration settings only for the Admin, not SubAdmin.

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

  • Backup/Restore > Basic > User Home or Free Trial Options

v1 UpdateServerConfig.do


URL

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

Deprecated Since Version: 7.15.6.38

v2 UpdateSystemSettings.do


UpdateSystemSetting.do was introduced for handling of features related to Quota Management.

A TrialQuotaList JSON Object (list of quota for multiple backup destinations for free trial users) was introduced to replace the single BackupQuotaSize parameter (v1 API).

URL

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

Available Since Version: 9.5

Parameters

Key Type Description
SysUser String Username of an AhsayCBS System User with Admin, API or Read-Only API role.
UserHomes Array When new user home is added, you need to include your existing user home in the array.
EnableFreeTrial Boolean Enable/Disable the Free Trial Registration option.
TrialQuotaList Array List of quota of backup destination for trial user, unit in byte.
ExpTrialStatus String Either "reset" or "suspend".
ExpTrialQuota String The quota of expired trial users, in number of bytes.
SuspendUserDays Integer The number of days when a user will be suspended. The value can be any one of the following: 7, 8,..., 29, 30, 45, 60, 75 and 90.
TrialMsExchange Boolean Enable/Disable the trial of Microsoft Exchange Server add-on module.
TrialMsSql Boolean Enable/Disable the trial of Microsoft SQL Server add-on module.
TrialMySQL Boolean Enable/Disable the trial of MySQL Database Server add-on module.
TrialMariaDB Boolean Enable/Disable the trial of MariaDB Database Server add-on module.
TrialOracle Boolean Enable/Disable the trial of Oracle Database Server add-on module.
TrialDomino Boolean Enable/Disable the trial of Lotus Domino add-on module.
TrialNotes Boolean Enable/Disable the trial of Lotus Notes add-on module.
TrialWinServer2008BareMetal Boolean Enable/Disable the trial of Windows System Backup add-on module.
TrialWinSysState Boolean Enable/Disable the trial of Windows System State Backup add-on module.
TrialVMware Boolean Enable/Disable the trial of VMware add-on module.
TrialVMwareQuota String VMware VM module quota. Integer value in string format.
TrialVMwareQuotaType String Default value is GUESTVM if not provided. The value can either be GUESTVM or SOCKET.
TrialMsVm Boolean Enable/Disable the trial of Hyper-V add-on module.
TrialMsVmQuota String Hyper-V module quota. Integer value in string format.
TrialMsVmQuotaType String Default value is GUESTVM if not provided. The value can either be GUESTVM or SOCKET.
TrialMsExchangeMailbox Boolean Enable/Disable the trial of Microsoft Exchange Mailbox add-on module.
TrialEMBQuota String Microsoft Exchange mailbox module quota. Integer value in string format.
TrialNasClient Boolean Enable/Disable the trial of NAS - Synology add-on module.
TrialQnap Boolean Enable/Disable the trial of NAS - QNAP add-on module.
TrialShadowProtectBareMetal Boolean Enable/Disable the trial of ShadowProtect System Backup add-on module.
TrialShadowCopy Boolean Enable/Disable the trial of Volume Shadow Copy add-on module.
TrialCdp Boolean Enable/Disable the trial of Continuous Data Protection add-on module.
TrialDeltaBlock Boolean Enable/Disable the trial of In-File Delta add-on module.
TrialMobile Boolean Enable/Disable the trial of Mobile add-on module.
TrialMobileQuota String Mobile add-on module quota. Integer value in string format.
TrialOffice365Mail Boolean Enable/Disable the trial of Microsoft 365 Backup add-on module.
TrialOffice365MailQuota String Microsoft 365 Backup add-on module quota. Integer value in string format.
TrialOpenDirect Boolean Enable/Disable the trial of OpenDirect / Granular Restore add-on module.
TrialOpenDirectQuota String OpenDirect / Granular Restore add-on module quota. Integer value in string format.
EnableRemoveUser Boolean Enable/Disable the remove trial user.
RemoveUserDays String Number of days after registration the free trial user will be removed. Integer value in string format.
SinceInactive Boolean Time period in which user has been inactive.
TrialQuotaType String Quota type, either TOTAL_QUOTA or PER_DESTINATION_QUOTA.
TrialStorageQuota Long Total quota in GB. Value validity examined when used by TOTAL_QUOTA.
TrialDeduplication Boolean Enable/Disable the trial of Deduplication add-on module.
TrialTibero Boolean Enable/Disable the trial of Tibero Database Server add-on module.
TrialLinuxBareMetal Boolean Enable/Disable the trial of Linux Bare Metal Backup add-on module.
TrialPostgreSql Boolean Enable/Disable the trial of PostgreSQL Server add-on module.
TrialProxmoxVE Boolean Enable/Disable the trial of Proxmox VE add-on module.
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

UserHome

Key Type Description
Path String Path of user home, e.g. "F:\\new_home".
Quota String Maximum QPS ratio of the user home. The value can be any one of the following: Unlimited, 300, 250, 200, 150, 100, 90, 80, 70, 60, 50, 40, 30, 20, 10 and 0. "0" refers to "Not Used".
status String Build status, can be: uploaded, waiting (idle), queued, building and finished.
Id String System user ID (0='system' username).

TrialQuotaList

Key Type Description
Enabled Boolean Enables or disables "Destinations" added/listed when "Per Destination Quota" is enabled.
Quota Long Quota of the backup destination, unit in byte. Value validity examined when used by PER_DESTINATION_QUOTA.
DestinationKey String ID of the backup destination, or "OBS" for AhsayCBS.
DestinationName String Name of the backup destination, example "AhsayCBS".
Examples

Example 1: INPUT = UpdateUserHomes

INPUT

{
	"SysUser":"api_user",
	"SysPwd":"qWeRtY123456!@#$%",
	"TrialQuotaList":[
		{
			"Enable":true,
			"Quota":549750000,
			"DestinationKey":"OBS"
		},
		{
			"Enable":true,
			"Quota":549750000,
			"DestinationKey":"-1585973679332"
		}
	]
}

OUTPUT

{
	"Status":"OK",
}

Example 2: INPUT = DisableTrialMariaDB

INPUT

{
	"SysUser":"api_user",
	"SysPwd":"qWeRtY123456!@#$%",
	"TrialMariaDB":false
}

OUTPUT

{
	"Status":"OK",
}