AddAllowedIP

July 21, 2025

This API allows you to add a range of IP of users which are allowed to perform restore in their computers.

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

  • Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > Backup Set > %Backup Set Name% > IP Allowed for Restore

URL

https://CBS.EXAMPLE.COM/obs/api/json/AddAllowedIP.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.
LoginName String Username of the backup user.
BackupSetID String ID of the backup set. Obtainable in ListBackupSets API.
NewAllowedIP AllowedIPBean Refer to AllowedIPBean.
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

AllowedIPBean

Key Type Description
StartIP String Starting value of allowable IP.
EndIP String (Ending value of allowable IP.
Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687501131522",
	"NewAllowedIP":{
		"StartIP":"1.1.1.1",
		"EndIP":"255.255.255.255"
}

OUTPUT

{
	"Status":"OK"
}
Documentation