Backup User

This subcategory focuses on retrieving information regarding the backup user as well as allowing creating, modifying and deleting user accounts. There is also an API for getting job status of server run backup jobs and also for updating the AUA of a user.

• ListUsers (v1,v2)
• AuthUser
• RunSingleUserRebuild
• GetSingleUserRebuildStatus
• GetUserStorageStat
• UpdateUserProfile (v1), UpdateUser (v2)
• AddContact
• AddUser (v1,v2)
• GetUser (v1,v2)
• ModifyUserStatus
• RemoveUser
• SendForgotPwdEmail
• GetUserStatus
• GetServerRunJobStatus
• UpdateAUA

ListUsers (v1,v2)

This API can be used to retrieve user’s information, with various filter options.

The settings can be found on the AhsayCBS web console at:

• Backup / Restore > Users, Groups & Policies > Backup User

v1 ListUsers.do

URL

https://CBS.EXAMPLE.COM/obs/api/json/ListUsers.do

Deprecated Since Version: 7.15.6.38

v2 ListUsers.do

v2 ListUsers.do API was introduced for handling of features related to Quota Management.

URL

https://CBS.EXAMPLE.COM/obs/api/json/2/ListUsers.do

Available Since Version: 9.7

Parameters

Return Values

JSON Objects

UserClientType

UserLoginName

User

QuotaList

UserGroup

Contact

ModuleUsage

Example

INPUT

{
	"SysUser":"system",
	"SysPwd":system1",
	"searchStr":"obm"
}

OUTPUT

{
	"Status":"OK",
	"User":[
		{
			"Timezone":"1098",
			"MobileQuota":0,
			"LoginName":"38367_new",
			"Owner":"",
			"ExpiryDate":25,
			"UserGroupIDList":[
				{
					"ShowLink":false,
					"UserGroupID":"1",
					"UserGroupName":"All Users"
				}
			],
			"EnableNASClient":false,
			"EnableMariaDB":false,
			"EnableOpenDirect":false,
			"DataFile":0,
			"MsVmQuotaType":"GUESTVM",
			"EnableShadowProtectBareMetal":false,
			"LdapUser":false,
			"EnableMobile":false,
			"DataSize":0,
			"EnableLotusDomino":false,
			"UserHome":"C:\\Users\username\Documents\cbase\user\38367_new",
			"ID":"1703141283712",
			"MsVmQuota":0,
			"Status":"ENABLE",
			"EnableVMware":false,
			"Office365MailQuota":0,
			"Hostname":"",
			"EnableDeduplication":true,
			"EnableMobileV2":false,
			"LdapDisableUser":-1,
			"LatestClientVersion":"",
			"EnableMSSQL":false,
			"VMwareQuotaType":"GUESTVM",
			"EnableLinuxBareMetal":false,
			"EnableLotusNotes":false,
			"VMwareQuota":0,
			"UserType":"PAID",
			"MobileAuthenticationSettings":{
				"MobileDeviceList":[],
				"Enable":false
			},
			"ClientType":"OBM",
			"EnableOracle":false,
			"RegistrationDate":1703141283712,
			"RecycleBinCompressed":0,
			"EnableExchangeMailbox":false,
			"QuotaList":[
				{
					"DestinationKey":"OBS",
					"Quota":52428800,
					"DestinationName":"AhsayCBS",
					"Enabled":true
				},
				{
					"DestinationKey":"-1700008764400",",
					"Quota":0,
					"DestinationName":"OneDrive-1",
					"Enabled":false
				},
				{
					"DestinationKey":"-1700025457535",
					"Quota":0,
					"DestinationName":"OneDrive-3",
					"Enabled":false
				}
			],
			"EnableCDP":false,
			"EnableInFileDelta":false,
			"SuspendPaidUserDate":"20241221",
			"MobileBackupSettings":{
				"DeviceList":[]
			},
			"MobileQuotaV2":0,
			"MobileUsage":{
				"MSExMailbox":0,
				"HostCount":1,
				"MSHyperVVM":0
				"VMwareCM":0
			},
			"EnableShadowCopy":false,
			"Language":"en",
			"Bandwidth":0,
			"StorageQuota":0,
			"LdapDeleteUser":-1,
			"EnableMySQL":false,
			"EnableOffice365Mail":false,
			"Notes":"",
			"OpenDirectQuota":0,
			"QuotaUsed":1,
			"EnableWinServer2008BareMetal":false,
			"RetainFile":0,
			"EnableQnatp":false,
			"QuotaType":"PER_DESTINATION_QUOTA",
			"EnableMsVm":false,
			"RetainSize":0,
			"RecycleBinFileNo":0,
			"LastBackupDate":0,
			"Contact":[],
			"EnableTibero":true,
			"AzureDestinationList":[],
			"UserId":"39367_new",
			"Alias":"",
			"ExchangeMailboxQuota":0,
			"EnableMsWinSysState":false,
			"SuspendPaidUser":false,
			"Online":false,
			"EnableMSExchange":false,
			"EnablePostgreSQL":false
		}
	]
}

AuthUser

This API checks whether a user exists or not.

The settings can be found on the AhsayCBS web console at:

• Backup / Restore > Users, Groups & Policies > Backup User

URL

https://CBS.EXAMPLE.COM/obs/api/json/AuthUser.do

Available Since Version: 9.1

Parameters

Return Values

Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"SampleUser",
	"Password":"SamplePassword"
}

OUTPUT 1

{
	"Status":"OK"
}

OUTPUT 2: User does not exist

{
	"Status":"Error",
	"Message":"[UserCacheManager.NoSuchUserExpt] User ‘NonExistentUser’ not found.",
	"ExptType":"com.ahsay.obs.core.dbs.ai"
}

RunSingleUserRebuild

This API rebuilds a particular v6 legacy backup set of a user.

The settings can be found on the AhsayCBS web console at:

• Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > Backup Set > %v6 Backup Set Name% > Destination > Standard Destination > Rebuild

URL

https://CBS.EXAMPLE.COM/obs/api/json/RunSingleUserRebuild.do

Available Since Version: 9.1

Parameters

Return Values

JSON Objects

Rebuild Status

Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1686639360356"
}

OUTPUT

{
	"Status":"OK"
}

OUTPUT 2: Backupset does not exist

{
	"Status":"OK",
	"Message":"Backup Set for ID='1686639360356' not found",
	"ExptType":"com.ahsay.obs.core.dbs.DbsException"
}

GetSingleUserRebuildStatus

This API allows you to get the information of the recent v6 legacy backup set rebuild.

The settings can be found on the AhsayCBS web console at:

• Monitoring > Administration Logs > Audit Trails

URL

https://CBS.EXAMPLE.COM/obs/api/json/GetSingleUserRebuildStatus.do

Available Since Version: 9.1

Parameters

Return Values

JSON Objects

RebuildStatus

Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1686639360356"
}

OUTPUT 1

{
	"Status":"OK",
	"Data":{
		"Status":"Finished",
		"LoginName":"obm",
		"EndTime":1686640128382,
		"StartTime":1686640127867,
		"BackupSetID":"1686639360356"
	}
}

OUTPUT 2: Not yet started

{
	"Status":"OK",
	"Data":{
		"Status":"Not yet started",
		"LoginName":"obm",
		"EndTime":-1,
		"StartTime":-1,
		"BackupSetID":""
	}
}

GetUserStorageStat

This API allows you to get the file statistic of a backup set of a user.

The settings can be found on the AhsayCBS web console at:

• Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > Statistics

URL

https://CBS.EXAMPLE.COM/obs/api/json/GetUserStorageStat.do

Available Since Version: 9.1

Parameters

Return Values

JSON Objects

AverageStat

DetailStat

Examples

Example 1

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"YearMonth":"2024-06"
}

OUTPUT

{
	"Status":"OK",
	"Data":{
		"AvgDataRawSize":"5504624",
		"AvgUploadRawSize":"5504624",
		"AvgRetainRawSize":"0",
		"AvgRetainUncompressed":"0",
		"AvgTotalStorageUncompressed":"0",
		"AvgUploadSize":"5.25 M",
		"AvgDataRawUncompresed":"5.9 M",
		"AvgDataUncompressed":"5.9 M",
		"AvgRetainSize":"0",
		"AvgTotalStorageSize":"5.25 M",
		"AvgTotalStorageRawUncompressed":"6183694",
		"AvgUploadUncompressed":"5.9 M",
		"AvgUploadNo":"53",
		"AvgTotalStorageNo":"39",
		"Storage":[
			{
				"UploadRawSize":"5504624",
				"TotalRestoreSize":0,
				"DataRawUncompressed":"6183694",
				"DataUncompressed":"5.9 M",
				"UploadRawUncompressed":"6183694",
				"TotalStorageNo":"39",
				"UploadNo":"39",
				"UploadSize":"5.25 M",
				"DataSize":"5.25 M",
				"TotalStorageRawSize":"5504624",
				"RetailRawUncompressed":"0",
				"TotalRestoreFileNo":"0",
				"TotalBackupSize":"5.25 M",
				"RetainUncompressed":"0",
				"TotalStorageUncompressed":"5.9 M",
				"RetainSize":"0",
				"RetainRawSize":"0",
				"DestinationID":"",
				"Date":"2024-06-14",
				"TotalStorageSize":"5.25 M",
				"RetainNo":"0",
				"UploadUncompressed":"5.9 M",
				"TotalStorageRawUncompressed":"6183694",
				"DataNo":"39",
				"TotalBackupFileNo":"39",
				"DataRawSize":"5504624"
			}
		],
		"YearMonth":"2024-06",
		"AvgUploadRawUncompressed":"6183694",
		"AvgRetainRawUncompressed":"0",
		"AvgRetainNo":"0",
		"AvgTotalStorageRawSize":"5504624",
		"AvgDataNo":"39"
	}
}

Example 2: No storage log found

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"YearMonth":"2024-01"
}

OUTPUT

{
	"Status":"Error",
	"Message":"No storage log found",
	"ExptType":"com.ahsay.obs.core.dbs.DbsException"
}

UpdateUserProfile (v1), UpdateUser (v2)

This API updates the information of a user profile.

The settings can be found on the AhsayCBS web console at:

• Backup / Restore > Users, Groups & Policies > Backup User > %User Name%

v1 UpdateUserProfile.do

URL

https://CBS.EXAMPLE.COM/obs/api/json/UpdateUserProfile.do

Deprecated Since Version: 7.15.6.38

v2 UpdateUser.do

To facilitate the Quota Management feature, a new version of the UpdateUserProfile.do API (v2 UpdateUser.do) was introduced.

URL

https://CBS.EXAMPLE.COM/obs/api/json/2/UpdateUser.do

Available Since Version: 9.5

Parameters

Return Values

JSON Objects

ModuleSettings

Contact

WindowsEventLogSettings

QuotaList

UserSuspendSettings

SystemSettings

Examples

Example 1

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"QuotaList":[
		{
			"Enabled":true,
			"DestinationKey":"OBM",
			"Quota":73400320
		}
	]
}

OUTPUT

{
	"Status":"OK"
}

Example 2: Add contacts (ChangeContact (Y))

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"ChangeContact":"Y",
	"NewContact":[
		{
			"Company":"Ahsay",
			"Email":"newcontact1@example.com",
			"Address":"newcontact1",
			"Website":"www.ahsay.com",
			"Name":"newcontact1",
			"Phone1":"1234",
			"Phone2":"1234"
		},
		{
			"Company":"Ahsay",
			"Email":"newcontact2@example.com",
			"Address":"newcontact2",
			"Website":"www.ahsay.com",
			"Name":"newcontact2",
			"Phone1":"1234",
			"Phone2":"1234"
		}
	]
}

OUTPUT

{
	"Status":"OK"
}

Example 3: Update contact (ChangeContact (Y))

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"ChangeContact":"Y",
	"OldContact":[
		{
			"Company":"Ahsay",
			"Email":"oldcontact1@example.com",
			"Address":"oldcontact1",
			"Website":"www.ahsay.com",
			"Name":"oldcontact1",
			"Phone1":"1234",
			"Phone2":"1234"
		},
		{
			"Company":"Ahsay",
			"Email":"oldcontact2@example.com",
			"Address":"oldcontact2",
			"Website":"www.ahsay.com",
			"Name":"oldcontact2",
			"Phone1":"1234",
			"Phone2":"1234"
		}
	],
	"NewContact":[
		{
			"Company":"Ahsay",
			"Email":"newcontact1@example.com",
			"Address":"newcontact1",
			"Website":"www.ahsay.com",
			"Name":"newcontact1",
			"Phone1":"1234",
			"Phone2":"1234"
		},
		{
			"Company":"Ahsay",
			"Email":"newcontact2@example.com",
			"Address":"newcontact2",
			"Website":"www.ahsay.com",
			"Name":"newcontact2",
			"Phone1":"1234",
			"Phone2":"1234"
		}
	]
}

OUTPUT: 'oldcontact1' and "oldcontact2' have been updated to 'newcontact1' and 'newcontact2'

{
	"Status":"OK"
}

Example 4 - Delete contact (ChangeContact (Y))

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"ChangeContact":"Y",
	"OldContact":[
		{
			"Company":"Ahsay",
			"Email":"oldcontact1@example.com",
			"Address":"oldcontact1",
			"Website":"www.ahsay.com",
			"Name":"oldcontact1",
			"Phone1":"1234",
			"Phone2":"1234"
		},
		{
			"Company":"Ahsay",
			"Email":"oldcontact2@example.com",
			"Address":"oldcontact2",
			"Website":"www.ahsay.com",
			"Name":"oldcontact2",
			"Phone1":"1234",
			"Phone2":"1234"
		},
		{
			"Company":"Ahsay",
			"Email":"newcontact1@example.com",
			"Address":"newcontact1",
			"Website":"www.ahsay.com",
			"Name":"newcontact1",
			"Phone1":"1234",
			"Phone2":"1234"
		},
		{
			"Company":"Ahsay",
			"Email":"newcontact2@example.com",
			"Address":"newcontact2",
			"Website":"www.ahsay.com",
			"Name":"newcontact2",
			"Phone1":"1234",
			"Phone2":"1234"
		}
	],
	"NewContact":[
		{
			"Company":"Ahsay",
			"Email":"oldcontact1@example.com",
			"Address":"oldcontact1",
			"Website":"www.ahsay.com",
			"Name":"oldcontact1",
			"Phone1":"1234",
			"Phone2":"1234"
		},
		{
			"Company":"Ahsay",
			"Email":"oldcontact2@example.com",
			"Address":"oldcontact2",
			"Website":"www.ahsay.com",
			"Name":"oldcontact2",
			"Phone1":"1234",
			"Phone2":"1234"
		},
		{
			"Company":"Ahsay",
			"Email":"newcontact2@example.com",
			"Address":"newcontact2",
			"Website":"www.ahsay.com",
			"Name":"newcontact2",
			"Phone1":"1234",
			"Phone2":"1234"
		}
	]
}

OUTPUT

{
	"Status":"Error"
}

Example 5: Append contacts with duplication (AppendContact (Y))

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"AppendContact":"Y",
	"Contact":[
		{
			"Company":"Ahsay",
			"Email":"oldcontact1@example.com",
			"Address":"oldcontact1",
			"Website":"www.ahsay.com",
			"Name":"oldcontact1",
			"Phone1":"1234",
			"Phone2":"1234"
		}
	]
}

OUTPUT

{
	"Status":"Error",
	"Message":"[UpdateUserProfile.checkDuplicatedEmail] Contact already exists <oldcontact1@example.com>",
	"ExptType":"com.ahsay.obs.core.dbs.DbsException"
}

Example 6: Append contacts without duplication (AppendContact (Y))

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"AppendContact":"Y",
	"Contact":[
		{
			"Company":"None",
			"Email":"oldcontact@example.com",
			"Address":"oldcontact",
			"Website":"www.ahsay.com",
			"Name":"oldcontact",
			"Phone1":"1234",
			"Phone2":"1234"
		}
	]
}

OUTPUT

{
	"Status":"OK"
}

Example 7: Delete all contacts (AppendContact (N))

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"AppendContact":"N",
	"Contact":[
		{
			"Company":"None",
			"Email":"oldcontact@example.com",
			"Address":"oldcontact",
			"Website":"www.ahsay.com",
			"Name":"oldcontact",
			"Phone1":"1234",
			"Phone2":"1234"
		}
	]
}

OUTPUT

{
	"Status":"OK"
}

Example 8: Replace all contacts (AppendContact (N))

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"AppendContact":"N",
	"Contact":[
		{
			"Company":"None",
			"Email":"oldcontact1@example.com",
			"Address":"oldcontact1",
			"Website":"www.ahsay.com",
			"Name":"oldcontact1",
			"Phone1":"1234",
			"Phone2":"1234"
		}
	]
}

OUTPUT

{
	"Status":"OK"
}

Example 9: Change module settings

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"ModuleSettings":{
		"ShadowCopyEnabled":true,
		"NasClientEnabled":true,
		"DeduplicationEnabled":false
	}
}

OUTPUT

{
	"Status":"OK"
}

Example 10: Change subscription type to 'PAID' and disable 'suspend at' option

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"Type":"PAID",
	"UserSuspendSettings":{
		"Enabled":false,
		"Date":2106396800000
	}
}

OUTPUT

{
	"Status":"OK"
}

Example 11 - Add or change 2FA phone number or Enable

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"Type":"PAID",
	"UserSuspendSettings":{
		"Enabled":false,
		"Date":2106396800000
	}
}

OUTPUT

{
	"Status":"OK"
}

AddContact

This API adds new contact information to a user.

The settings can be found on the AhsayCBS web console at:

• Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > User Profile > Contact

URL

https://CBS.EXAMPLE.COM/obs/api/json/AddContact.do

Available Since Version: 9.1

Parameters

Return Values

JSON Objects

Contact

Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"NewContact":{
		"Name":"contact1",
		"Email":"contact1@examle.com"
	}
}

OUTPUT

{
	"Status":"OK"
}

OUTPUT 2: Duplicate contact email

{
	"Status":"Error",
	"Message":"[UpdateUserProfile.checkDuplicatedEmail] Contact already exists <contact1@example.com>",
	"ExptType":"com.ahsay.obs.core.dbs.DbsException"
}

AddUser (v1,v2)

This API can be used to add new backup user.

The settings can be found on the AhsayCBS web console at:

• Backup / Restore > Users, Groups & Policies > Backup User

v1 AddUser.do

URL

https://CBS.EXAMPLE.COM/obs/api/json/AddUser.do

Deprecated Since Version: 7.15.6.38

v2 AddUser.do

URL

https://CBS.EXAMPLE.COM/obs/api/json/2/AddUser.do

Available Since Version: 9.5

Parameters

QuotaList

Return Values

Examples

Example 1: Add AhsayOBM paid user with AhsayCBS quota 50 GB and predefined destination quota of 50 GB

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm2",
	"Password":"obm2",
	"Email":"obm2@example.com",
	"Type":"Paid",
	"Status":"ENABLE",
	"ClientType":"OBM",
	"QuotaList":[
		{
			"Enabled":true,
			"DestinationKey":"-1686812937526",
			"Quota":53687091200
		}
	]
}

OUTPUT

{
	"Status":"OK"
}

OUTPUT 2: If destination is not visible to user

{
	"Status":"Error",
	"Message":"Destination ‘-1686812937526’ is not visible to user ‘obm2’ according to policy’s [Destinations Visible to Users] settings.",
	"ExptType":"java.lang.Exception"
}

OUTPUT 3: If the Enable parameter is missing from a destination in the QuotaList

{
	"Status":"Error",
	"Message":"Value ‘Enabled’ is missing in item ‘-1686812937526’ of ‘QuotaList’.",
	"ExptType":"java.lang.Exception"
}

OUTPUT 4: If Enable is invalid for a destination in the QuotaList

{
	"Status":"Error",
	"Message":"Invalid ‘Enabled’ in item ‘-1686812937526’ of ‘QuotaList’.",
	"ExptType":"java.lang.Exception"
}

OUTPUT 5: If a destination is duplicated in the QuotaList

{
	"Status":"Error",
	"Message":"Duplicated DestinationKey (-1686812937526) are not allowed in the QuotaList.",
	"ExptType":"java.lang.Exception"
}

OUTPUT 6: If the Quota value for a destination is invalid (e.g. a negative number)

{
	"Status":"Error",
	"Message":"Invalid value for ‘Quota’ for item ‘-1686812937526’ of ‘QuotaList’. Error: Must be a positive number.",
	"ExptType":"java.lang.Exception"
}

OUTPUT 7: If the Quota value for a destination is invalid

{
	"Status":"Error",
	"Message":"Invalid value ‘Quota’ for item ‘-1686812937526’ of ‘QuotaList’. Error: JSONObject [\”Quota\”] is not a long (class java.lang.String: ac130).",
	"ExptType":"java.lang.Exception"
}

Example 2: Add AhsayOBM paid user with AhsayCBS quota 50 GB and Total Quota 75 GB

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm1",
	"Password":"obm1",
	"Email":"testobm@example.com",
	"Type":"Paid",
	"Status":"ENABLE",
	"ClientType":"OBM",
	"QuotaType":"TOTAL_QUOTA",
	"StorageQuota":75,
	"QuotaList":[
		{
			"DestinationKey":"OBS",
			"Quota":53687091200,
			"DestinationName":"AhsayCBS",
			"Enabled":true
		}
	]
}

OUTPUT

{
	"Status":"OK"
}

Example 3: Invalid Quota value specified

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm2",
	"Password":"obm2",
	"Email":"obm2@example.com",
	"Type":"Paid",
	"Status":"ENABLE",
	"ClientType":"OBM",
	"QuotaList":[
		{
			"Enabled":true,
			"DestinationKey":"OBS",
			"Quota":53687091200
		}
	]
}

OUTPUT

{
	"Status":"OK"
}

GetUser (v1,v2)

This API can be used to retrieve the information of a backup user.

The settings can be found on the AhsayCBS web console at:

• Backup / Restore > Users, Groups & Policies > Backup User > %User Name%

v1 GetUser.do

URL

https://CBS.EXAMPLE.COM/obs/api/json/GetUser.do

Deprecated Since Version: 7.15.6.38

v2 GetUser.do

URL

https://CBS.EXAMPLE.COM/obs/api/json/2/GetUser.do

Available Since Version: 9.7

Parameters

Return Values

JSON Objects

User

QuotaList

ContactList

EmailReportSettings

ForgotPasswordSettings

GroupPolicySettings

HostInfo

HostSet

LastSuccessfulLoginInfo

LdapSettings

ModuleSettings

PasswordHistory

MoveUserHomeRecord

ProxySettings

RoutineJobsSettings

SecuritySettings

TotalStatistics

UserLockSettings

UserSuspendSettings

windowsEventLogSettings

ModuleUsage

Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm2"
}

OUTPUT

{
	"Status":"OK",
	"Data":{
		"Timezone":"1098",
		"ClientRunVersion":"",
		"Owner":"",
		"HostCount":1,
		"SoftwareUpdateSettings":{
			"ReadOnly":false,
			"Enabled":true,
			"Id":""
		},
		"ModuleSettings":{
			"MobileQuota":0,
			"VMwareVMQuotaType":"GUESTVM",
			"VMwareVMQuota":0,
			"MobileEnabled":false,
			"DeltaMergeEnabled":false,
			"MSExchangeMailboxBackupEnabled":false,
			"DeduplicationEnabled":false,
			"MariaDBBackupEnabled":false,
			"OracleBackupEnabled":false,
			"QnapEnabled":false,
			"MSExchangeBackupEnabled":false,
			"OpenDirectEnabled":false,
			"VMwareBackupEnabled":false,
			"InFileDeltaEnabled":false,
			"MSHyperVVMQuota":0,
			"MySQLBackupEnabled":false,
			"MobileV2Quota":0,
			"LotusDominoBackupEnabled":false,
			"OpenDirectQuota":0,
			"MobileV2Enabled":false,
			"ReadOnly":false,
			"Office365MailQuota":0,
			"MSHyperVVMQuotaType":"GUESTVM",
			"NasClientEnabled":false,
			"MSSQLBackupEnabled":false,
			"MSExchangDAGServerQuota":0,
			"ShadoeProtectBackupEnabled":false,
			"MSWindowsSystemStateBackupEnabled":false,
			"MSHyperVBackupEnabled":false,
			"ShadowCopyEnabled":false,
			"LotusNotesBackupEnabled":false,
			"Id":"",
			"Office365MailEnabled":false,
			"CDPEnabled":false,
			"MSExMailboxQuota":0,
			"MSWindowsSystemBackupEnabled":false
		},
		"PasswordHistory":{
			"ReadOnly":false,
			"HistoryList":[],
			"PasswordLastModifiedTime":1687069108460,
			"Id":""
		},
		"RunDirectQuotaEnabled":false,
		"Name":"obm2",
		"AccessToken":"E1C9029954184F92B858280B9A6A3EBAA4F8809CA3E441C198ED5C2DE57918C3",
		"UserHome":"C:\\Program Files\\AhsayCBS\\user\\obm2",
		"LastSuccessfulLoginInfo":null,
		"WindowsEventLogSettings":{
			"ReadOnly":false,
			"LogLoginLogout":false,
			"LogInfo":false,
			"LogLicense":false,
			"Enabled":false,
			"LogUtilities":false,
			"LogError":false,
			"LogServices":false,
			"Id":"",
			"LogSoftwareUpdate":false,
			"LogProfile":false,
			"LogRestore":false,
			"LogBackup":false,
			"LogWarn":false,
			"LogBuy":false,
			"LogReport":false
		},
		"UserSuspendSettings":{
			"ReadOnly":false,
			"Enabled":false,
			"Id":"",
			"Date":0
		},
		"Status":"ENABLE",
		"ReadOnly":false,
		"LockedByMFA":false,
		"OpenDirectUsageCount":0,
		"EncodedName":"obm2",
		"MobileUserID":null,
		"Updated":false,
		"SavePassword":false,
		"BackupSetIdList":[],
		"Hostname":"jcvm.com",
		"MailboxUsage":0,
		"TrialDays":2592000000,
		"DoubleEncodedName":"obm2",
		"LastClientLoginTime":-1,
		"PlanAmount":-1,
		"UploadEncryptionKey":false,
		"GroupPolicySettings":{
			"ReadOnly":false,
			"UserGroupIDList":[-1],
			"ExcludeNetworkShare":false,
			"GroupQuota":0,
			"Id":"",
			"UserGroupQuota":0,
			"FileSizeLimit":0
		},
		"YearPlan":null,
		"LastShowingLicViolationTime":-1,
		"Id":"1687069108461",
		"RunDirectQuota":1,
		"File":"C:\\Program Files\\AhsayCBS\\con\\users.xml",
		"MobileAuthenticationSettings":{
			"Enable":false,
			"LastCountryCode":""
		},
		"ForgotPasswordSettings":{
			"ReadOnly":false,
			"Token":"",
			"RequestTime":-1,
			"Id":"",
			"ResetTime":-1
		},
		"LdapSettings":{
			"ReadOnly":false,
			"LdapUser":false,
			"LastDeleteTime":0,
			"LastDisableTime":0,
			"Id":"",
			"FirstAuthFailureTime":-1
		},
		"TopDir":"C:\\Program Files\\AhsayCBS\\user",
		"EnableAUA":true,
		"ClientType":"OBM",
		"RegistrationDate":1687069108460,
		"QuotaList":[
			{
				"DestinationKey":"OBS",
				"Quota":5368091200,
				"DestinationName":"AhsayCBS",
				"Enabled":true
			},
			{
				"DestinationKey":"-1687068833705",
				"Quota":0,
				"DestinationName":"Local-1",
				"Enabled":false
			},
			{
				"DestinationKey":"-1686815201815",
				"Quota":0,
				"DestinationName":"AhsayCBS-1",
				"Enabled":false
			}
		],
		"ProxySettings":{
			"ReadOnly":false,
			"Type":"",
			"Username":"",
			"Port":"",
			"Enabled":false,
			"Host":"",
			"Id":"",
			"Password":""
		},
		"HostQuotaEnabled":false,
		"AdGroups":[1],
		"ComputerNameDirList":null,
		"SecuritySettings":{
			"UserLockSettings":{
				"LockedTime":-1,
				"LastFailureTime":-1,
				"LoginFailureCount":0
			},
			"PhoneList":[],
			"Enable":false,
			"SendLimitSettings":{
				"LastSendTime":-1,
				"SendCount":0
			},
			"RecoverySettings":{
				"Token":"",
				"ExpiryTime":-1
			}
		},
		"AdGroup":"1",
		"SuspendPaidUserDate":"19700101",
		"MobileBackupSettings":{
			"DeviceList":[]
		},
		"HostSet":{
			"":""
		},
		"Locked":false,
		"CloudbackoGoDriveEnabled":false,
		"Language":"en",
		"ServerSettings":null,
		"HomeDir":"C:\\Program Files\\AhsayCBS\\user\\obm2",
		"Bandwidth":0,
		"StorageQuota":100,
		"class":"com.ahsay.obs.core.cxp.User",
		"HashedPassword":true,
		"SecurityIdentifier":"",
		"Notes":"",
		"Password":"BSJEajFurvvTdkh1V4+1Asgw6wjjIpkgK3rJ00y5S87B0=",
		"RemovingLogs":null,
		"NewBSetName":"BackupSet-0",
		"ImportDate":0,
		"UserLockSettings":{
			"LockedTime":-1,
			"LastFailureTime":-1,
			"LoginFailureCount":0
		},
		"TotalStatistics":{
			"TotalRecycleBinUncompressedSize":0,
			"DataAreaFileCount":0,
			"TotalRestoreCompressedSize":0,
			"TotalRecycleBinFileCount":0,
			"LastBackupCompressedSize":0,
			"DataAreaCompressedSize":0,
			"LastBackupUncompressedSize":0,
			"RetentionAreaFileCount":0,
			"RetentionAreaUncompressedSize":0,
			"DataAreaUncompressedSize":0,
			"TotalUploadCompressedSize":0,
			"LastBackupFileCount":0,
			"TotalUploadFileCount":0,
			"TotalRestoreFileCount":0,
			"TotalRecycleBinCompressedSize":0,
			"RetentionAreaCompressedSize":0
		},
		"QuotaType":"PER_DESTINATION_QUOTA",
		"V6File":"C:\\Program Files\\AhsayCBS\\user\\obm2\\db\\Profile.xml",
		"RoutineJobSettings":{
			"ReadOnly":false,
			"QuotaRemindPercentage":0,
			"Id":"",
			"InactiveReportLastSentTime":-1
		},
		"LongLoginName":"obm2",
		"ContactList":[
			{
				"ReadOnly":false,
				"Company":"",
				"Phone1":"",
				"Email":"obm2@example.com",
				"Address":"",
				"EmailCertificate":"",
				"Phone2":"",
				"EncryptEmail":false,
				"Website":"",
				"Id":"1687069108462",
				"Name":""
			}
		],
		"EmailReportSettings:{
			"SendBkpRpt":false,
			"ReadOnly":false,
			"Usage":0,
			"Email":"",
			"ReportSenderEmail":"",
			"SmtpAuthUser":"",
			"Enabled":false,
			"SendBkpRptMode":"",
			"SmtpHostName":"",
			"MissedBkpInterval":0,
			"SmtpProtocol":"",
			"Id":"",
			"SmtpPort":"",
			"SendMissedBkpRpt":false,
			"SendStorageAlert":false,
			"SmtpAuthPwd":""
		},
		"LastLoginTime":0,
		"Type":"PAID",
		"UsedHostQuota":0,
		"Alias":"",
		"UserId":"obm2",
		"FullName":null,
		"PreV7":false,
		"TrialExpiryDate":0,
		"MoveUserHomeRecord":null,
		"HostQuota":1,
		"HostInfo":""
	}			
}

ModifyUserStatus

This API can be used to modify a user account status to either enable or suspended. It cannot be used for trial user accounts which are suspended after they have exceeded the trial period.

The settings can be found on the AhsayCBS web console at:

• Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > User Profile > General

URL

https://CBS.EXAMPLE.COM/obs/api/json/ModifyUserStatus.do

Available Since Version: 9.1

Parameters

Return Values

Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm2",
	"Status":"SUSPENDED"
}

OUTPUT

{
	"Status":"OK"
}

OUTPUT 2: User does not exist

{
	"Status":"Error",
	"Message":"[UserCacheManager.NoSuchUserExpt] User ‘obm2’ not found.",
	"ExptType":"com.ahsay.obm.core.dbs.ai"
}

RemoveUser

This API removes a backup user.

The settings can be found on the AhsayCBS web console at:

• Backup / Restore > Users, Groups & Policies > Backup User

URL

https://CBS.EXAMPLE.COM/obs/api/json/RemoveUser.do

Available Since Version: 9.1

Parameters

Return Values

Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm2"
}

OUTPUT

{
	"Status":"OK"
}

SendForgotPwdEmail

This API will send a forgot password email to a backup user who forgot their login password, to allow them to reset their login password.

URL

https://CBS.EXAMPLE.COM/obs/api/json/SendForgotPwdEmail.do

Available Since Version: 9.1

Parameters

Return Values

Examples

Example 1

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm"
}

OUTPUT

{
	"Status":"OK"
}

Example 2: Login name is incorrect / does not exist

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm2"
}

OUTPUT

{
	"Status":"Error",
	"Message":"[UserCacheManager.NoSuchUserExpt] User 'obm2' not found.",
	"ExptType":"com.ahsay.obs.core.dbs.ai"
}

GetUserStatus

This API can be used to retrieve detailed information of backup or restore jobs that are currently running.

The settings can be found on the AhsayCBS web console at:

• Monitoring > Live Activities > Backup User > Backup Status or Restore Status

URL

https://CBS.EXAMPLE.COM/cbs/api/json/GetUserStatus.do

Available Since Version: 9.1

Parameters

Return Values

JSON Objects

BkpStatus / RestoreStatus

Examples

Example 1: If "Type" is "backup" ("Type":"backup")

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm"
}

OUTPUT

{
	"Status":"OK",
	"BkpStatus":[
		{
			"LoginName":"obm",
			"Owner":"",
			"ClientType":"OBM",
			"CurrentFileType":"",
			"UploadedNumOfLinks":"0",
			"ElapsedTime":"4 sec",
			"BackupSetID":"1687077919738",
			"DestinationType":"OBS",
			"CurrentFile":"",
			"TransferRate":"0bit/s",
			"LastMessage":"[1687077949198] Using Temporary Directory C:\\Users\’user’\\.obm\\temp\\1687077919738\\OBS@1687077949198",
			"UploadedSize":"0",
			"LastUpdateTime":"06/18/2024 16:46:03",
			"EstimatedTimeLeft":"0 sec",
			"DestinationName":"AhsayCBS",
			"BackupSet":"Backup Set Test (File Backup)",
			"SizeLeft":"0",
			"ID":"0",
			"DeltaFilePercent":"0",
			"DeltaType":"",
			"UploadedNumOfFiles":"0",
			"CurrentFileOperation":"",
			"BackupJobID":"2024-06-18-16-45-58",
			"DestinationID":"1687077949198",
			"OverallPercent":"0",
			"Type":"FILE",
			"CurrentFilePercent":"0",
			"UserID":"1686791459557",
			"Alias":"obm",
			"DeltaFile":"",
			"UploadedNumOfDirs":"0",
			"UserType":"PAID",
			"BackupStatus":"info"
		}
	]	
}

Example 2: If "Type" is "restore" ("Type":"restore")

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm"
}

OUTPUT

{
	"Status":"OK",
	"RestoreStatus":[
		{
			"LoginName":"obm",
			"Owner":"",
			"ClientType":"OBM",
			"CurrentFileType":"",
			"UploadedNumOfLinks":"0",
			"ElapsedTime":"0 sec",
			"BackupSetID":"1687077919738",
			"DestinationType":"OBS",
			"CurrentFile":"",
			"TransferRate":"0bit/s",
			"LastMessage":"start,Start [ AhsayOBM v9.5.4.0 ],0,0,0,,0,0\r\n",
			"UploadedSize":"0",
			"LastUpdateTime":"06/18/2024 16:58:28",
			"EstimatedTimeLeft":"0 sec",
			"DestinationName":"AhsayCBS",
			"BackupSet":"Backup Set Test (File Backup)",
			"SizeLeft":"0",
			"ID":"0",
			"DeltaFilePercent":"0",
			"ExecuteJob":"",
			"RestoreJobID":"2024-06-18-16-58-28
			"DeltaType":"",
			"UploadedNumOfFiles":"0",
			"CurrentFileOperation":"",
			"DestinationID":"1687077949198",
			"OverallPercent":"0",
			"Type":"FILE",
			"CurrentFilePercent":"0",
			"UserID":"1686791459557",
			"Alias":"obm",
			"DeltaFile":"",
			"UploadedNumOfDirs":"0",
			"UserType":"PAID",
			"BackupStatus":"info"
		}
	]	
}

GetServerRunJobStatus

This API can be used to retrieve detailed information of Run-on-Server (agentless) backup or restore jobs that are currently running.

The settings can be found on the AhsayCBS web console at:

• Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > Backup Set > Execute Job

URL

https://CBS.EXAMPLE.COM/cbs/api/json/GetServerRunJobStatus.do

Available Since Version: 9.1

Parameters

Return Values

JSON Objects

RunJob

Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm"
}

OUTPUT

{
	"Status":"OK",
	"RunJob":[
		{
			"BackupSetID":"1687077919738",
			"ExecuteJob":""
		}
	]	
}

UpdateAUA

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

Return Values

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"
}