UpdateConfig - Backup Server

July 21, 2025

The UpdateConfig.do API can be used to update the following settings of AhsayCBS: Proxy Server, Admin Contacts, System Homes, SNMP Settings, Windows Event Logs and Connectors.

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

System Settings > Basic > General or Email
System Settings > Advanced > Proxy or Logging

URL

https://CBS.EXAMPLE.COM/cbs/api/json/UpdateConfig.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.
UseEventLog	Boolean	Whether event log is enabled.
EventLogName	String	Name of event log.
Hostname	String	Hostname of the AhsayCBS server.
SystemHome	String	The directory containing all system files.
WebServers	Array of WebServer	Connectors
SmtpServers	Array of SmtpServer	Smtp server settings.
AdminContacts	Array of Contact	Admin contacts in array.
UseProxy	Boolean	Enable/Disable proxy server.
ProxyUsername	String	User name of the proxy server.
ProxyPassword	String	Password of the user of the proxy server.
ProxyType	String	The value can either be: HTTP or SOCK.
ProxyHost	String	Hostname of the proxy server.
ProxyPort	String	Port used by the proxy server.
ProxyExcludeHosts	Array of ProxyExcludeHost	Excluded hostnames and IP addresses for proxy connection.
EnableSnmp	Boolean	Enable / Disable SNMP.
SnmpStartIP	String	Starting IP for SNMP.
SnmpEndIP	String	Ending IP for SNMP.
SnmpTrapInfo	Boolean	SNMP trap level information.
SnmpTrapWarn	Boolean	SNMP trap level warning.
SnmpTrapErr	Boolean	SNMP trap level error.
SnmpPort	Integer	SNMP trap port numbers.
SnmpTrapRecv1	SnmpTrapRecv	Receiver 1
SnmpTrapRecv2	SnmpTrapRecv	Receiver 2
SnmpTrapRecv3	SnmpTrapRecv	Receiver 3
PreventSessionHijackingEnabled	Boolean	Enable/Disable prevent session hijacking.

Query Parameters

Key	Type	Description
Product	String	Either "CBS" or "OBC".
Mode	String	(optional) "all" or "single"

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

WebServer

Key	Type	Description
Id	Integer	Usually starts from 0, in ascending order.
Ip	String	This is designed for servers with multiple IP addresses. This attribute specifies which IP address will be used for listening on the specified port. If only one (1) IP address is used on your system, the default value 0.0.0.0 can be used.
Port	String	The TCP port number on which this connector will create a server socket and await incoming connections. Please make sure this port is not occupied by other applications in your system.
Protocol	String	The can either be: http or https.
MaxConn	String	Maximum number of connections allowed to the server.
MaxKeepAliveReq	String	Maximum number of requests to serve on a TCP connection.
ConnTimeout	String	Connection timeout in milliseconds.
SslCertificateId	String	Name of an existing SSL Certificate present in AhsayCBS. Empty string if not applicable.
RxBufSize	String	Size in bytes of the receive buffer socket. Default is 25188.
TxBufSize	String	Size in bytes of the send buffer socket. Default is 43800.

SmtpServer

Key	Type	Description
HostName	String	Host name of the SMTP server.
Port	Integer	Connection port of the SMTP server.
SecureProtocol	Boolean	If set to true, it will require a secure protocol for login.
Auth	Boolean	Set to false, if SMTP server does not require login credentials.
AuthUser	String	Username used to login.
AuthPwd	String	User password.
ReportSender	Contact	Contact that sends reports.
Owner	String	Name of owner, empty if owner is Admin.

Contact

Key	Type	Description
Name	String	Primary name of contact.
Owner	String	Name of owner, empty if owner is Admin
Email	String	Email address of contact.
Address	String	Address detail of contact.
ReceiveBccEmail	Boolean	Allows BCC of outgoing emails

ProxyExcludeHost

Key	Type	Description
Host	String	Hostname or IP address of the proxy server.

SnmpTrapRecv

Key	Type	Description
Enable	Boolean	True / False
Host	String	Hostname of SNMP.
TrapPort	String	Port to be used for the trap.

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.

Examples

Example 1

INPUT

{
	"SysUser":"api_user",
	"SysPwd":"qWeRtY123456!@#$%",
	"SendBccReports":true,
	"AdminContacts":[{"Name":"New1","Email":"New1@example.com"}]
}

OUTPUT

{
	"Status":"OK"
}

Example 2 - ReportSettingsBean