UpdateLicense

July 21, 2025

This API can be used to update the licensee name and license key on the AhsayCBS server for the redirector.

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

  • System Settings > License > Redirector

URL

https://CBS.EXAMPLE.COM/rdr/api/json/UpdateLicense.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.
LicenseeName String Licensee name of redirector key.
LicenseKey String Product key for redirector.
UseProxy Boolean Enable / disable the use of proxy defined in 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":"system",
	"SysPwd":"system1",
	"LicenseeName":"Ahsay_Test_RDR",
	"LicenseKey":"qwerty-5jjM4+Sz-SCz68XG+J"
}

OUTPUT 1

{
	"Status":"OK",
	"Key":"qwerty-5jjM4+Sz-SCz68XG+J",
	"Deactivated":false,
	"Licensee":"Ahsay_Test_RDR"
}

OUTPUT 2

{
	"Status":"OK",
	"Key":"qwerty-5jjM4+Sz-SCz68XG+J",
	"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":"Ahsay_Test_RDR"
}

OUTPUT 3

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

OUTPUT 4

{
	"Status":"OK",
	"Key":"qwerty-5jjM4+Sz-SCz68XG+J",
	"Deactivated":false,
	"Info":"[OEM Liccense.checkLicTime] License expired on 2023-01-01. Backup server is stopped"
	"Licensee":"Ahsay_Test_RDR"
}
Documentation