UpdateServerConfig

July 21, 2025

This API can be used to update the Redirector module's setting.

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

  • Redirection > Hosting a Redirector > Server Configuration

URL

https://CBS.EXAMPLE.COM/rdr/api/json/UpdateServerConfig.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.
SkipDuplicateUserCheck Boolean Do not check duplicate users.
BackupServer Array Redirector will redirect user to these backup servers.
EnableRdr Boolean True / False.
FreeTrialServer Integer ID of the backup server for free trial registration.
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".
JSON Objects

Backup Servers

Key Type Description
ID Long ID of the configuration.
Enabled Boolean True / False.
HttpEnabled Boolean True / False.
SslEnabled Boolean True / False.
LoginName String Login name used for the backup server.
Password String Password used for the backup server.
Hostname String Hostname or IP address.
HttpPort Integer Port used by the backup server.
SslPort Integer SSL port used by the backup server.
Class Integer The value must be "com.ahsay.cbs.rdr.config.system.EditServerConfigBean$BackupServerBean".
Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"BackupServers":[
		{
			"Id":"1",
			"Enabled":true,
			"HttpEnabled":false,
			"SslEnabled":true,
			"LoginName":"system",
			"Password":"system1",
			"Hostname":"rcvr.com",
			"HttpPort":80,
			"SslPort":443,
			"Class":"com.ahsay.cbs.rdr.config.system.EditServerConfigBean$BackupServerBean"
		}
	],
	"SkipDuplicateUserCheck":false,
	"EnabledRdrFreeTrial":true
}

OUTPUT

{
	"Status":"OK"
}
Documentation