AddDeselectSrc
October 14, 2025
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
| 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. |
| DeselectedSrc | 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":"C:\\Testing1\\data" |
| Username | String | If username and password are empty, add the 'src' without credential. |
| Password | String | If username and password are empty, add the 'src' without credential. |
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"
}