UpdateAUA
July 21, 2025
This API can be used to toggle a list of Backup User(s) Auto Update Agent (AUA) setting.
The settings can be found on the AhsayCBS web console at:
- Backup / Restore > Users, Groups & Policies > Backup User > tick %User Name%
URL
https://CBS.EXAMPLE.COM/obs/api/json/UpdateAUA.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. |
Enabled | Boolean | Set the list of users to enable / disable Auto Update. |
UserIdList | String | Multiple login names (case sensitive), separated by commas. For example: user1, user2, uSEr3. |
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". |
Examples
Example 1
INPUT
{
"SysUser":"system",
"SysPwd":"system1",
"Enabled":false,
"UserIdList":"user1, user2"
}
OUTPUT
{
"Status":"OK"
}
Example 2
INPUT
{
"SysUser":"system",
"SysPwd":"system1",
"UserIdList":"user1, user2"
}
OUTPUT
{
"Status":"Error",
"Message":"[Error] Parameter Enabled is null / empty!",
"ExptType":"com.ahsay.obs.core.dbs.DbsException"
}
Example 3
INPUT
{
"SysUser":"system",
"SysPwd":"system1",
"Enabled":true,
"UserIdList":"obm2"
}
OUTPUT
{
"Status":"Error",
"Message":"[UserCacheManager.NoSuchUserExpt] User ‘obm2’ not found.",
"ExptType":"com.ahsay.obs.core.dbs.ai"
}