GetReplicationMode

July 21, 2025

This API can be used to retrieve the current replication status on the backup server.

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

  • Monitoring > Replication Logs

URL

https://CBS.EXAMPLE.COM/obs/api/json/GetReplicationMode.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.
Return Values
Key Type Description
Status String "OK" or "Error"
Data ConfigData Contains the particulars of replication settings.
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

ReplicationData

Key Type Description
Enable Boolean Enable / Disable the replication.
Replicators Array of Replicator Shows details of all Replicators enlisted in the Backup Server.

Replicator

Key Type Description
LoginName String Client user name.
BackupSetID String The 13-digit backup set ID.
Mode String The value can be any one of the following: RESYNC, REPLAY, PENDING and SLEEPING.
File String The file that is currently replicating.
Example

INPUT 

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

OUTPUT 

{
	"Status":"OK",
	"Data":{
		"Enable":true,
		"Replicators":[
			{
				"LoginName":"userA",
				"File":"",
				"BackupSetID":"1463141188151",
				"Mode":"RESYNC"
			}
		]
	}
}
Documentation