AddBackupSet

July 21, 2025

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

You may need to complement AddBackupSet with UpdateBackupSet API.

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

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.
Platform String The value can be one of the following: windows, mac or linux. Will determine the value for the "Temporary directory for storing backup files" value.
CloudFileType String The type of cloud file, please use one of the available types within the set provided in the table "Destination Type".
CloudBackupSourceSettings JSON Object The settings for the cloud backup source, the underlying parameters are specific to each destination type. Please refer to the tables labeled with “DestinationSettings (DESTINATION_TYPE)” under ADDPREDEFINEDDESTINATION API for the correct format of each cloud file type.
BackupSetName String Name of the new backup set.
BackupSetType String Backup type of the new backup set. The value can be one of the following: FILE. Cloud File, Lotus Domino, Lotus Notes, MariaDB, Microsoft Exchange Server, Microsoft Exchange Mail (MAPI), Microsoft SQL Server, Microsoft Windows Virtualization, Microsoft Windows System Backup, MySQL, Office 365 Exchange Online, Oracle Database Server, ShadowProtect Bare Metal, System State, VMware Virtualization, Linux Bare Metal, Tibero Database Server, Linux Bare Metal, PostgreSQL and Proxmox VE. Default value is FILE if BackupSetType is not specified.
BackupMode String Mandatory for BackupSetType="Microsoft SQL Server". Backup mode of MSSQL can either be 0:VSS or 1:ODBC.
VmVersion String Mandatory for BackupSetType="VMware Virtualization". VM version can be one of the following: APPVERSION_ESX_V2 (VMware ESX 4), APPVERSION_ESXI_V2 (VMware ESXi 4 or above), APPVERSION_VMSERVER1 (VMware Server 1), APPVERSION_VMSERVER2 (VMware Server 2), APPVERSION_WORKSTATION (VMware Workstation 6 / 6.5 / 7), APPVERSION_WORKSTATION8 (VMware Workstation 8 or above), APPVERSION_PLAYER (VMware Player 3 / 4 / 5 / 6 / 7, VMware Workstation Player 12), APPVERSION_FUSION (VMware Fusion 3 / 4), APPVERSION_FUSION5 (VMware Fusion 5 / 6 / 7 / 8) and APPVERSION_VCENTER_V2 (VMware vCenter 4 or above).
MsVmVersion String Mandatory for BackupSetType="Microsoft Windows Virtualization". MS VM version can be one of the following: Microsoft Hyper-V Server, Microsoft Hyper-V Server R2, Microsoft Hyper-V Server R2 (Failover Cluster), Microsoft Hyper-V Server 2012, Microsoft Hyper-V Server 2012 (Failover Cluster), Microsoft Hyper-V Server 2012 R2, Microsoft Hyper-V Server 2012 R2 (Failover Cluster), Microsoft Hyper-V Server 2016, Microsoft Hyper-V Server 2016 (Failover Cluster), Microsoft Hyper-V Server 2019 and Microsoft Hyper-V Server 2019 (Failover Cluster).
Version String Mandatory for BackupSetType="Microsoft Exchange Server". MS Exchange Server version can be one of the following: 8 (MS Exchange Server 2007), 14 (MS Exchange Server 2010), 15 (MS Exchange Server 2013), 15.1 (MS Exchange Server 2016), 15.2 (MS Exchange Server 2019), DAG13 (MS Exchange Server 2013 (DAG)), DAG16 (MS Exchange Server 2016 (DAG)), DAG19 (MS Exchange Server 2019 (DAG)) and DAG (MS Exchange Server 2010 (DAG)).
MsMAPIExVersion String Mandatory for BackupSetType="Microsoft Exchange Mail (MAPI)". MS Exchange Mail version can be one of the following: 8 (MS Exchange Server 2007), 14 (MS Exchange Server 2010), 15 (MS Exchange Server 2013), 15.1 (MS Exchange Server 2016), 15.2 (MS Exchange Server 2019), DAG13 (MS Exchange Server 2013 (DAG)), DAG16 (MS Exchange Server 2016 (DAG)), DAG19 (MS Exchange Server 2019 (DAG)) and DAG (MS Exchange Server 2010 (DAG)).
EncryptionType String Encryption type of the backup set. The value can be one of the following: DEFAULT, PASSWORD, CUSTOM and blank for no encrption. If the Encryption Type is not provided to the API = Encryption type not defined, This require the end user to define the Encryption type in the AhsayOBM/AhsayACB client for the backup set. If the EncryptionType = PASSWORD the BackupUserPassword must be specified.
BackupUserPassword String Used when EncryptionType = PASSWORD. The BackupUserPassword must match with the existing user login password on the AhsayOBM/AhsayACB user account. Otherwise return error "The Backup User Password does not match with the existing user password".
Algorithm String Encryption algorithm of the backup set. The value can be set to one of the following: Twofish, DESede and AES. Default to AES if not provided.
Method String Encryption method of the backup set. The value can be set to one of the following: ECB and CBS. Default to CBC if not provided.
Length String Encryption key length of the backup set. The value can be set to one of the following: 128 and 256. Default to 256 if not provided.
Key String Encryption key of the backup set. The value cannot be empty.
RunOnServer Boolean Run on Server setting for Cloud File and Microsoft 365 backup set. If this setting is set to "True", "EncryptionType" cannot be left empty.
DestinationList Array of Destination Optional.
EnableOpenDirect Boolean Enable OpenDirect feature. Only applies to pre-v9.13 AhsayCBS.
Return Values
Key Type Description
Status String "OK" or "Error"
BackupSetID String Backup set ID of the created 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".
JSON Objects

Destination

Key Type Description
Type String Destination type, can be either OBS or Local.
Name String (Optional) If blank and the Type="OBS", the default value for the name is "CBS". If blank and the Type="Local", the default value for the name is "Local".
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"
}
Documentation