UpdateLicense

July 21, 2025

This API can be used to update the license name and license key on the AhsayCBS server (for backup server).

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

  • System Settings > License > Backup

URL

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

Available Since Version: 9.1

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.
Licensee String Licensee name.
Key String Product key.
UseProxy Boolean Enable/disable the use of proxy defined in the AhsayCBS to connect to the internet.
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".
Example

INPUT 

{
	"SysUser":"api_user",
	"SysPwd":"qWeRtY123456!@#$%",
	"Licensee":"ABC_Backup",
	"Key":"XyZ98-AbcDE-fGhU-98bcd-YZ"
}

OUTPUT 1 - When License status is normal 

{
	"Status":"OK",
	"Key":"XyZ98-AbcDE-fGhU-98bcd-YZ",
	"Deactivated":false,
	"Licensee":"ABC_Backup"
}

OUTPUT 2 - User action required (e.g. click the Update button on the web console) 

{
	"Status":"OK","Key":"XyZ98-AbcDE-fGhU-98bcd-YZ","Deactivated":false,"Info":
	"Internal Error 1012. Please press the [Update] button in license page to correct this problem.
	If the problem persists, please contact our technical support team to resolve this problem","Licensee":"ABC_Backup"
}

OUTPUT 3 - When incorrect License Key was provided 

{
	"Status":"Error",
	"Message":"License key incorrect. Please try again."
}

OUTPUT 4 - When AhsayCBS service was stopped 

{
	"Status":"OK","Key":"XyZ98-AbcDE-fGhU-98bcd-YZ","Deactivated":false,"Info":"[OEM-License.checkLicTime] License expired on 2024-01-01. Backup server is stopped","Licensee":"ABC_Backup"
}
Documentation