UpdateReceivers

July 21, 2025

This API can be used to update settings of an existing replication receiver setting. You should use ListReceiver.do to obtain the current values, to pass back values to keep along with your changes, UpdateReceivers.do is designed as overwrite mode.

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

Replication > Accepting Data > Receiver

URL

https://CBS.EXAMPLE.COM/rps/api/json/UpdateReceivers.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.
Id	Long	Use ListReceiver.do to obtain the response output from existing ‘Id’, then pass it back using UpdateReceivers.do with your changes.
ReplicationEnabled	Boolean	Enable replication of the receiver.
LoginName	String	Login name of the replication receiver account.
Password	String	Password or the replication receiver.
Alias	String	Alias of the reciver.
ListenPort	Integer	Listening port (e.g. 9444) of the source backup server. (applies to v6 only)
ListenHost	String	Bind to (example "0.0.0.0") (applies to v6 Replication).
SystemHome	String	The Replication System Home path (default Home Directory) for the replication receiver.
RestoreRunning	Boolean	If the replication snapshot will be restored or not.
TrafficLimits	Array of TrafficLimit	Limit the usage of network bandwidth by the replication service.
UserHomeMappings	Array of UserHomeMapping	The source backup server user home location.
RestoringPath	String	Path of the restore.
IPRestrictions	Array of IPRestriction	To restrict the range of IP that can access the receiver.
RestoreStatus	String	Restore job status.
ObsVersion	Integer	The backup server version. If 0, means v6 Sender. If 1, means v7+.
ObsHost	String	Backup server host (FQDN).
ObsProtocol	String	Can either be HTTP or HTTPS.
ObsSysUser	String	The system user login of the backup server, stored when Add New Receiver.
ObsSysPwd	String	The system user password login of the backup server.
ObsPort	Integer	The backup server connector port.
RestorePointInterval	Integer	Value for the Replication Retention Setting.
RetentionCustomizationPolicy	Integer	Value for the Replication Retention Setting.
CrcEnabled	Boolean	Cyclic Redundancy Check checking. (applies to v6 Replication)
CrcHour	Integer	Monthly at HH:HH. (applies to v6 Replication)
CrcMinute	Integer	Monthly at HH:HH. (applies to v6 Replication)
MigrateFromV6	Boolean	Whether to migrate from v6 or not.
V6ReplicationEnabled	Boolean	If v6 Replication setting is enabled, then pass the ListentPort and ListenHost keys.

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

TrafficLimit

Key	Type	Description
ID	String	ID of the limit.
Name	String	Label name.
Always	Boolean	If True, MaxTransferRate is always applied regardless of time.
FromDayOfWeek	Integer	0 = Sunday, 6 = Friday.
FromHour	Integer	In 24-hour format.
FromMin	Integer	In 60-minute format.
ToDayOfWeek	Integer	0 = Sunday, 6 = Friday.
ToHour	Integer	In 24-hour format.
ToMin	Integer	In 60-minute format.
MaxTransferRate	Long	Maximum transfer rate in bytes.

UserHomeMapping

Key	Type	Description
RPSDir	String	Replication Home.
OBSHome	String	Backup server user home.

IPRestriction

Key	Type	Description
ID	Long	ID of the restriction.
From	String	IP address
To	String	IP address

Examples

Example 1: Enable Replication

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"Id":0,
	"ReplicationEnabled":true,
	"LoginName":"rcvr",
	"Password":"rcvr1",
	"Alias":"rcvr",
	"ObsProtocol":"https",
	"ObsHost":"rcvr.com",
	"ObsPort":"443",
	"ObsVersion":1,
	"ObsSysUser:"system",
	"ObsPwd":"system1",
	"V6ReplicationEnabled":false,
	"MigrateFromV6":false,
	"ListenHost":"0.0.0.0",
	"ListenPort":9444,
	"CrcEnabled":false,
	"CrcHour":0,
	"CrcMinute":0,
	"RestorePointInterval":30,
	"RetentionCustomizationPolicy":60,
	"SystemHome":"C:\\Program Files\\AhsayCBS\\system\\rps\\rcvshome\\rcvr",
	"UserHomeMappings":[
		{
			"RPSDir":"F:\\rcvr",
			"OBSHome":"C:\\Program Files\\AhsayCBS\\user"
		}
	],
	"IPRestrictions:[],
	"TrafficLimits":[]
}

OUTPUT

{
	"Status":"OK"
}

Example 2: Disable Replication