UpdateReplicationConfig

July 21, 2025

This API can be used to update the following replication settings: replication destination, replication proxy server, replication traffic limmit and replication backup set.

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

  • Replication > Sending Data > Replication

URL

https://CBS.EXAMPLE.COM/obs/api/json/UpdateReplicationConfig.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.
EnableReplication Boolean Enable/disable the option to replicate back up data to predefined cloud storage.
RepDestId String Destination ID of the replication destination.
ReplicationUseProxy Boolean Enable/disable the use of proxy option in replication profile.
ReplicationUseTrafficLimit Boolean Enable/disable the use of replication traffic limit.
TrafficLimits Array of TrafficLimit Configure the traffic limit settings to contro traffic at a specific time.
ReplicateIndividualBSet Boolean Enable/disable the option to replicate individual backup set.
ReplicateNewPaidBSet Boolean Enable/disable the option to replicate new backup sets of paid users.
ReplicateNewTrialBSet Boolean Enable/disable the option to replicate new backup sets of trial users.
RepBSet Array of RepBSet List of individual backup sets marked for individual replication.
For Parameter "RepBSet", the array must relist to contain all backup sets for replication.
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
StartDayOfWeek Integer The start day of traffic limit. "1" stands for Sunday, "2" stands for Monday and so on.
StartHour Integer The start hour of traffic limit.
StartMin Integer The start minute of traffic limit.
EndDayOfWeek Integer The end day of traffic limit. "1" stands for Sunday, "2" stands for Monday and so on.
EndHour Integer The end hour of traffic limit.
EndMin Integer The end minute of traffic limit.
MaxTransferPerSec String Maximum number of Kbytes transferred per second.

RepBSet

Key Type Description
Value String The username and backup set ID of the replicated backup set, joined with “++” as separator. For example, UserABC++123456789.
For Key "Value", API will update the whole list, so any existing backup sets in the list will be removed if your "RepBSet" array does not include them.
Examples

Example 1: Traffic Limit

INPUT 

{
	"SysUser":"api_user",
	"SysPwd":"qWeRtY123456!@#$%",
	"EnableReplication":true,
	"ReplicationUseTrafficLimit":true,
	"TrafficLimits":[
		{
			"StartDayOfWeek":"4",
			"StartHour":"3",
			"StartMin":"30",
			"EndDayOfWeek":"5",
			"EndHour":"4",
			"EndMin":"30",
			"MaxTransferPerSec":"300"
		}
	]
}

OUTPUT 

{
	"Status":"OK"
}

Example 2: Create or Update RepBSet List (not necessary to include subadmin#)

INPUT 

{
	"SysUser":"api_user",
	"SysPwd":"qWeRtY123456!@#$%",
	"EnableReplication":true,
	"ReplicateIndividualBSet":true,
	"RepBSet":[
		{"Value":"user12345++1578027193000"},
		{"Value":"user67890++1578059639000"}
	]
}

OUTPUT 

{
	"Status":"OK"
}

Example 3: Enable replication of new trial backup sets

INPUT 

{
	"SysUser":"api_user",
	"SysPwd":"qWeRtY123456!@#$%",
	"EnableReplication":true,
	"ReplicateNewTrialBSet":true
}

OUTPUT 

{
	"Status":"OK"
}
Documentation