AhsayCBSGetSystemSetting (v1, v2) - Backup Server
July 21, 2025
This API can be used to retrieve backup server related configuration such as the User Home and Free Trial Options 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 GetSystemSetting.do
URL
https://CBS.EXAMPLE.COM/cbs/api/json/GetSystemSetting.do
Deprecated Since Version: 7.15.6.38
v2 GetSystemSetting.do
GetSystemSetting.do was introduced for handling of features related to Quota Management.
URL
https://CBS.EXAMPLE.COM/obs/api/json/2/GetSystemSetting.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. |
| SysPwd | String | Password matching SysUser. |
Return Values
| Key | Type | Description |
|---|---|---|
| Status | String | "OK" or "Error" |
| Data | ConfigData | Particulars of a user's configuration data. |
| 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
UserHomes
| Key | Type | Description |
|---|---|---|
| QuotaSum | Long | Consolidated total of a user's Quota in UserHomes. |
| Quota | String | Maximum quota of a user. |
| PasswordProtected | Boolean | Whether it is located in a password protected network drive. |
| Password | String | Password used to login to user account. |
| Username | String | Login name of a user account. |
| CurrentRatio | Long | Current QPS ratio. |
| Path | String | Path to the user home. |
| Size | Long | Size of the user home. |
ConfigData
| Key | Type | Description |
|---|---|---|
| EnableFreeTrial | Boolean | Enable/Disable the Free Trial Registration option. |
| ExpTrialStatus | String | "reset" or "suspend" |
| SuspendUserDays | Integer | The number of days before the user account gets suspended. The value can be any one of the following: 7, 8, ..., 29, 30, 45, 60, 75 and 90. |
| SinceInactive | Boolean | Time period in which user has been inactive. |
| TrialMsExchange | Boolean | Trial option of Microsoft Exchange Server add-on module. |
| TrialMsSql | Boolean | Trial option of Microsoft SQL Server add-on module. |
| TrialMySql | Boolean | Trial option of MySQL Database Server add-on module. |
| TrialOracle | Boolean | Trial option of Oracle Database Server add-on module. |
| TrialDomino | Boolean | Trial option of Lotus Domino add-on module. |
| TrialNotes | Boolean | Trial option of Lotus Notes add-on module. |
| TrialWinServer2008BareMetal | Boolean | Trial option of Windows System Backup add-on module. |
| TrialMsWinSysState | Boolean | Trial option of Windows System State Backup add-on module. |
| TrialVMware | Boolean | Trial option of VMware add-on module. |
| TrialVMwareQuotaType | Array | Default value is GUESTVM if not provided. The value can either be: GUESTVM or SOCKET. |
| TrialMsVm | Boolean | Trial option of Hyper-V add-on module. |
| TrialMsVmQuotaType | Array | Default value is GUESTVM if not provided. The value can either be: GUESTVM or SOCKET. |
| TrialMsExchangeMailbox | Boolean | Trial option of Microsoft Exchange Mailbox add-on module. |
| TrialEMBQuota | String | Microsoft Exchange Mailbox module quota. |
| TrialNasClient | Boolean | Trial option of NAS - Synology add-on module. |
| TrialQnap | Boolean | Trial option of NAS - QNAP add-on module. |
| TrialShadowProtectBareMetal | Boolean | Trial option of ShadowProtect System Backup add-on module. |
| TrialShadowCopy | Boolean | Trial option of Volume Shadow Copy add-on module. |
| TrialCdp | Boolean | Trial option of Continuous Data Protection add-on module. |
| TrialDeltaBlock | Boolean | Trial option of In-File Delta add-on module. |
| TrialMariaDB | Boolean | Trial option of MariaDB Database Server add-on module. |
| TrialMobile | Boolean | Trial option of Mobile add-on module. |
| TrialMobileQuota | String | The quota of mobile add-on module. |
| TrialOpenDirect | Boolean | Trial option of OpenDirect / Granular Restore add-on module. |
| TrialOpenDirectQuota | String | The quota of OpenDirect / Granular Restore add-on module. Only works on pre-v9.13 AhsayCBS. |
| EnableRemoveUser | Boolean | Option to remove trial user account. |
| RemoveUserDays | String | The number of days when to remove user after registration. The value can be any one of the following: 30, 60, 90, 120, 150 and 180. |
| UserHomes | Array | Path of the User Home. |
| 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 | Trial option of Deduplication add-on module. |
| TrialTibero | Boolean | Trial option of Tibero Database Server add-on module. |
| TrialLinuxBareMetal | Boolean | Trial option of Linux Bare Metal Backup add-on module. |
| TrialPostgreSql | Boolean | Trial option of PostgreSQL Server add-on module. |
ReportSettingsBean
| Key | Type | Description |
|---|---|---|
| SendLowDiskSpaceReminderAlertReport | Boolean | Whether Low Disk Space Reminder/Alert report will be sent to the admin/subadmin. |
| LowDiskSpaceReminderThreshold | Integer | Threshold value for sending reminder when disk space is low. Value can be one of the following: 60, 65, 70, 75, 80, 85, 90, 91, 92, 93, 94, 95, 96, 97, 98 and 99. |
| LowDiskSpaceAlertThreshold | Integer | Threshold value for sending alert when disk space is low. Value can be one of the following: 60, 65, 70, 75, 80, 85, 90, 91, 92, 93, 94, 95, 96, 97, 98 and 99. |
| SendLowDestinationSpaceReminderAlertReport | Boolean | Whether Low Destination Space Reminder/Alert report will be sent to the admin/subadmin. |
| LowDestinationSpaceReminderThreshold | Integer | Threshold value for sending reminder when destination space is low. Value can be one of the following: 60, 65, 70, 75, 80, 85, 90, 91, 92, 93, 94, 95, 96, 97, 98 and 99. |
| LowDestinationSpaceAlertThreshold | Integer | Threshold value for sending alert when destination space is low. Value can be one of the following: 60, 65, 70, 75, 80, 85, 90, 91, 92, 93, 94, 95, 96, 97, 98 and 99. |
| SendAdministratorConsolidatedReport | Boolean | Whether Consolidated Admin report will be sent to the admin/subadmin. |
| ConsolidatedReportSendHour | Integer | Hour when consolidated report is sent. |
| ConsolidatedReportSendMin | Integer | Minute when consolidated report is sent. |
TrialQuotaList
| Key | Type | Description |
|---|---|---|
| Name | String | Name of the backup destination. |
| Quota | String | Unit in bytes. Value validity examined when used by PER_DESTINATION_QUOTA. |
| DestinationKey | String | ID of the predefined destination, or OBS for quota on AhsayCBS. |
| Quota | Integer | Unit in bytes. |
Example
INPUT
{
"SysUser":"api_user",
"SysPwd":"qWeRtY123456!@#$%"
}
OUTPUT
{
"Status":"OK",
"Data":{
"TrialMsVmQuotaType":[],
"TrialMsVmQuota":"5",
"TrialDeduplication":false,
"TrialCdp":false,
"TrialMySql":false,
"TrialQuotaType":"TOTAL_QUOTA",
"TrialMobileV2":false,
"ExpTrialStatus":"suspend",
"TrialShadowCopy":true,
"TrialMobile":false,
"TrialShadowProtectBareMetal":false,
"TrialWinServer2008BareMetal":false,
"TrialMsVmQuotaType":"GUESTVM",
"TrialQuotaList":[
{
"DestinationKey":"OBS",
"Quota":52428800,
"Enabled":true,
"Name":"AhsayCBS"
}
]
"TrialMobileQuotaV2":"0",
"TrialVMware":false,
"TrialOracle":false,
"TrialVMwareQuotaType":[],
"RemoveUserDays":"90",
"ReportSettingsBean":{
"SendLowDiskSpaceReminderAlertReport":true,
"SendLowDestinationSpaceReminderAlertReport":true,
"ConsolidatedReportSendHour":13,
"LowDestinationSpaceAlertThreshold":90,
"LowDestinationSpaceReminderThreshold":65,
"LowDiskSpaceAlertThreshold":80,
"LowDiskSpaceReminderThreshold":70,
"SendAdministratorConsolidatedReport":true,
"ConsolidatedReportSendMin":45
},
"TrialStorageQuota":85,
"TrialOffice365Mail":false,
"TrialMsVm":false,
"TrialMobileQuota":"0",
"TrialOpenDirect":false,
"TrialNasClient":false,
"TrialMsSql":false,
"TrialNotes":false,
"TrialOpenDirectQuota":"10",
"UserHomes":[
{
"Path":"C:\\Users\username\Documents",
"QuotaSum":53896806400,
"Quota":"Unlimited",
"Username":"",
"Size":959637876737,
"CurrentRatio":5.613692,
"PasswordProtected":false,
"Password":""
},
{
"Path":"C:\\Users\username\Desktop",
"QuotaSum":104857600,
"Quota":"Unlimited",
"Username":"",
"Size":959637876736,
"CurrentRatio":0.010926789,
"PasswordProtected":false,
"Password":"y8.BxMA="
}
],
"TrialEMBQuota":"20",
"TrialDomino":false,
"TrialQnap":false,
"TrialMsExchangeMailbox":false,
"EnableFreeTrial":true,
"TrialMsExchange":false,
"TrialOffice365MailQuota":"10",
"EnableRemoveUser":true,
"TrialDeltaBlock":false,
"SinceInactive":false,
"SuspendUserDays":25,
"TrialMariaDB":true,
"TrialLinuxBareMetal":false,
"TrialVMwareQuotaType":"GUESTVM",
"TrialMsWinSysState":false,
"TrialTibero":false,
"TrialPostgreSql":false
}
}