GetReplicationStatus

July 21, 2025

This API can be used to get the Live Activities Replication Status of either the “Replication” (Sender, AhsayCBS Backup Server) or “Receiver” (AhsayCBS Replication Server).

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

  • Monitoring > Live Activities > Replication
  • Monitoring > Live Activities > Receiver

 

URL

https://CBS.EXAMPLE.COM/cbs/api/json/GetReplicationStatus.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.
Type String Either replicate or receive.
Return Values
Key Type Description
Status String "OK" or "Error"
Message String Error message, it only appears if status displays "Error".
RepStatus Array of RepStatus It exists only if Type is "replicate".
RecStatus Array of RecStatus It exists only if Type is "receive".
JSON Objects

RepStatus "Type" is "replicate"

Key Type Description
BackupSetName String Backup set name
LoginName String Backup username
Owner String Backup user owner
ClientType String OBM or ACB
isSysFiles Boolean True if replicate for user settings or system file, False if replicate backup set data.
Mode String Mode: SLEEP, RESYNC, REPLAY, PENDING
Type String Backup set type
StartTime String Start time of the replication job
BackupSetID String Backup set ID
Alias String Alias of the job entry
ReplicatedFile String File being replicated
UserID String User ID
EstimatedTimeLeft String Estimated time left
ID String ID of the entry object
UserType String PAID or TRIAL
Progress String Percentage done of replication

RepStatus "Type" is "receive"

Key Type Description
ReplicatedFile String File last replicated
EstimatedTimeLeft String Estimated time left
Mode String Receiving mode
StartTime String Start time of the receiving job
Receiver String Receiver name
ID String ID of the receiver
inactive Boolean Inactive or not
Progress String Progress percentage
Examples

Example 1: Type is "receive"

INPUT 

{
	"SysUser":"api_user",
	"SysPwd":"qWeRtY123456!@#$%",
	"Type":"receive"
}

OUTPUT 

{
	"Status":"OK",
	"ReloadReceiveStatus":"true",
	"RecStatus":[
		{
			"ReplicatedFile":"",
			"Progress":0,
			"inactive":true,
			"EstimatedTimeLeft":"-",
			"Mode":"REPLAY",
			"StartTime":"10:03:29",
			"Receiver":"rcvr",
			"ID":"3495085"
		}
	]
}

Example 2: Type is "replicate"

INPUT 

{
	"SysUser":"api_user",
	"SysPwd":"qWeRtY123456!@#$%",
	"Type":"replicate"
}

OUTPUT 

{
	"ReloadReplicateStatus":"true",
	"Status":"OK",
	"RepStatus":[
		{
			"BackupSetName":"v6 File Backup",
			"LoginName":"obm",
			"Owner":"",
			"ClientType":"OBM",
			"Progress":100,
			"Mode":"SLEEP",
			"StartTime":"10:05:15",
			"BackupSetID":"1687750405259",
			"isSysFiles":false,
			"ReplicatedFile":"",
			"Type":"FILE",
			"UserID":"109818",
			"Alias":"obm",
			"EstimatedTimeLeft":"-",
			"ID":"1687750405259",
			"UserType":"PAID"
		},
		{
			"BackupSetName":"default-backup-set-name-1",
			"LoginName":"obm",
			"Owner":"",
			"ClientType":"OBM",
			"Progress":100,
			"Mode":"SLEEP",
			"StartTime":"06/29/202410:48:25",
			"BackupSetID":"1687755057644",
			"isSysFiles":false,
			"ReplicatedFile":"",
			"Type":"FILE",
			"UserID":"109818",
			"Alias":"obm",
			"EstimatedTimeLeft":"-",
			"ID":"1687755057644",
			"UserType":"PAID"
		},
		{
			"BackupSetName":"Configuration and system files",
			"LoginName":"",
			"Owner":"",
			"ClientType":"",
			"Progress":0,
			"Mode":"SLEEP",
			"StartTime":"-",
			"BackupSetID":"",
			"isSysFiles":true,
			"ReplicatedFile":"",
			"Type":"",
			"UserID":"0",
			"Alias":"",
			"EstimatedTimeLeft":"-",
			"ID":"",
			"UserType":""
		}
	]
}
Documentation