AddSelectSrc

July 21, 2025

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

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 ID of the backup set. Obtainable in ListBackupSets API.
SelectedSrc Array of SourceBean One or multiple Source paths, as an array of "Src".
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, it appears only if status is "Error".
JSON Objects

SourceBean

Key Type Description
Src String

Special characters for JAVA must be escaped, for example, “\” must be replaced with “\\”.

Example: "Src":"Microsoft 365/Users/John.Doe@example.com/Outlook/Inbox"

Example: "Src":"C:\\Testing1\\data"

UserName String If username and password are empty, add the 'src' without credentials.
Password String If username and password are empty, add the 'src' without credentials.
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"
}
Documentation