System Config

This subcategory provides users with APIs that allows for the configuration of settings such as servers and system settings, addition of predefined destinations, and updates to AhsayCBS licenses among other functions.

• UpdateServerConfig (v1), UpdateSystemSettings (v2) - Backup Server
• UpdateConfig - Backup Server
• GetSystemSettings (v1,v2) - Backup Server
• UpdateReplicationConfig
• UpdateLicense
• GetLicense (v1,v2)
• GetReplicationMode
• AddPredefinedDestination

UpdateServerConfig (v1), UpdateSystemSettings (v2) - Backup Server

This API can be used to update Backup Server related configuration such as the User Home and Free Trial user registration settings only for the Admin, not SubAdmin.

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

• Backup/Restore > Basic > User Home or Free Trial Options

v1 UpdateServerConfig.do

URL

https://CBS.EXAMPLE.COM/obs/api/json/UpdateServerConfig.do

Deprecated Since Version: 7.15.6.38

v2 UpdateSystemSettings.do

UpdateSystemSetting.do was introduced for handling of features related to Quota Management.

A TrialQuotaList JSON Object (list of quota for multiple backup destinations for free trial users) was introduced to replace the single BackupQuotaSize parameter (v1 API).

URL

https://CBS.EXAMPLE.COM/obs/api/json/2/UpdateSystemSetting.do

Available Since Version: 9.5

Parameters

Return Values

JSON Objects

UserHome

TrialQuotaList

Examples

Example 1: INPUT = UpdateUserHomes

INPUT

{
	"SysUser":"api_user",
	"SysPwd":"qWeRtY123456!@#$%",
	"TrialQuotaList":[
		{
			"Enable":true,
			"Quota":549750000,
			"DestinationKey":"OBS"
		},
		{
			"Enable":true,
			"Quota":549750000,
			"DestinationKey":"-1585973679332"
		}
	]
}

OUTPUT

{
	"Status":"OK",
}

Example 2: INPUT = DisableTrialMariaDB

INPUT

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

OUTPUT

{
	"Status":"OK",
}

UpdateConfig - Backup Server

The UpdateConfig.do API can be used to update the following settings of AhsayCBS: Proxy Server, Admin Contacts, System Homes, SNMP Settings, Windows Event Logs and Connectors.

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

• System Settings > Basic > General or Email
• System Settings > Advanced > Proxy or Logging

URL

https://CBS.EXAMPLE.COM/cbs/api/json/UpdateConfig.do

Available Since Version: 9.1

Parameters

Query Parameters

Return Values

JSON Objects

WebServer

SmtpServer

Contact

ProxyExcludeHost

SnmpTrapRecv

ReportSettingsBean

Examples

Example 1

INPUT

{
	"SysUser":"api_user",
	"SysPwd":"qWeRtY123456!@#$%",
	"SendBccReports":true,
	"AdminContacts":[{"Name":"New1","Email":"New1@example.com"}]
}

OUTPUT

{
	"Status":"OK"
}

Example 2 - ReportSettingsBean

INPUT

{
	"SysUser":"api_user",
	"SysPwd":"qWeRtY123456!@#$%",
	"ReportSettingsBean":{
		"SendLowDiskSpaceReminderAlertReport":true,
		"SendLowDestinationSpaceReminderAlertReport":true,
		"LowDestinationSpaceAlertThreshold":90,
		"LowDestinationSpaceReminderThreshold":65,
		"LowDiskSpaceAlertThreshold":85,
		"LowDiskSpaceReminderThreshold":70,
		"SendAdministratorConsolidatedReport":true,
		"ConsolidatedReportSendHour":13,
		"ConsolidatedReportSendMin":45
	}
}

OUTPUT

{
	"Status":"OK"
}

GetSystemSetting (v1,v2) - Backup Server

This API can be used to retrieve backup server related configuration such as the User Home and Free Trial Options only for the Admin, not SubAdmin.

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

• Backup/Restore > Basic > User Home or Free Trial Options

v1 GetSystemSetting.do

URL

https://CBS.EXAMPLE.COM/cbs/api/json/GetSystemSetting.do

Deprecated Since Version: 7.15.6.38

v2 GetSystemSetting.do 

GetSystemSetting.do was introduced for handling of features related to Quota Management.

URL

https://CBS.EXAMPLE.COM/obs/api/json/2/GetSystemSetting.do

Available Since Version: 9.5

Parameters

Return Values

JSON Objects

UserHomes

ConfigData

ReportSettingsBean

TrialQuotaList

Example

INPUT

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

OUTPUT

{
	"Status":"OK",
	"Data":{
		"TrialMsVmQuotaType":[],
		"TrialMsVmQuota":"5",
		"TrialDeduplication":false,
		"TrialCdp":false,
		"TrialMySql":false,
		"TrialQuotaType":"TOTAL_QUOTA",
		"TrialMobileV2":false,
		"ExpTrialStatus":"suspend",
		"TrialShadowCopy":true,
		"TrialMobile":false,
		"TrialShadowProtectBareMetal":false,
		"TrialWinServer2008BareMetal":false,
		"TrialMsVmQuotaType":"GUESTVM",
		"TrialQuotaList":[
			{
				"DestinationKey":"OBS",
				"Quota":52428800,
				"Enabled":true,
				"Name":"AhsayCBS"
			}
		]
		"TrialMobileQuotaV2":"0",
		"TrialVMware":false,
		"TrialOracle":false,
		"TrialVMwareQuotaType":[],
		"RemoveUserDays":"90",
		"ReportSettingsBean":{
			"SendLowDiskSpaceReminderAlertReport":true,
			"SendLowDestinationSpaceReminderAlertReport":true,
			"ConsolidatedReportSendHour":13,
			"LowDestinationSpaceAlertThreshold":90,
			"LowDestinationSpaceReminderThreshold":65,
			"LowDiskSpaceAlertThreshold":80,
			"LowDiskSpaceReminderThreshold":70,
			"SendAdministratorConsolidatedReport":true,
			"ConsolidatedReportSendMin":45
		},
		"TrialStorageQuota":85,
		"TrialOffice365Mail":false,
		"TrialMsVm":false,
		"TrialMobileQuota":"0",
		"TrialOpenDirect":false,
		"TrialNasClient":false,
		"TrialMsSql":false,
		"TrialNotes":false,
		"TrialOpenDirectQuota":"10",
		"UserHomes":[
			{
				"Path":"C:\\Users\username\Documents",
				"QuotaSum":53896806400,
				"Quota":"Unlimited",
				"Username":"",
				"Size":959637876737,
				"CurrentRatio":5.613692,
				"PasswordProtected":false,
				"Password":""
			},
			{
				"Path":"C:\\Users\username\Desktop",
				"QuotaSum":104857600,
				"Quota":"Unlimited",
				"Username":"",
				"Size":959637876736,
				"CurrentRatio":0.010926789,
				"PasswordProtected":false,
				"Password":"y8.BxMA="
			}
		],
		"TrialEMBQuota":"20",
		"TrialDomino":false,
		"TrialQnap":false,
		"TrialMsExchangeMailbox":false,
		"EnableFreeTrial":true,
		"TrialMsExchange":false,
		"TrialOffice365MailQuota":"10",
		"EnableRemoveUser":true,
		"TrialDeltaBlock":false,
		"SinceInactive":false,
		"SuspendUserDays":25,
		"TrialMariaDB":true,
		"TrialLinuxBareMetal":false,
		"TrialVMwareQuotaType":"GUESTVM",
		"TrialMsWinSysState":false,
		"TrialTibero":false,
		"TrialPostgreSql":false
	}
}

UpdateReplicationConfig

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

Return Values

JSON Objects

TrafficLimit

RepBSet

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"
}

UpdateLicense

This API can be used to update the license name and license key on the AhsayCBS server (for backup server).

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

• System Settings > License > Backup

URL

https://CBS.EXAMPLE.COM/obs/api/json/UpdateLicense.do

Available Since Version: 9.1

Parameters

Return Values

Example

INPUT

{
	"SysUser":"api_user",
	"SysPwd":"qWeRtY123456!@#$%",
	"Licensee":"ABC_Backup",
	"Key":"XyZ98-AbcDE-fGhU-98bcd-YZ"
}

OUTPUT 1 - When License status is normal

{
	"Status":"OK",
	"Key":"XyZ98-AbcDE-fGhU-98bcd-YZ",
	"Deactivated":false,
	"Licensee":"ABC_Backup"
}

OUTPUT 2 - User action required (e.g. click the Update button on the web console)

{
	"Status":"OK","Key":"XyZ98-AbcDE-fGhU-98bcd-YZ","Deactivated":false,"Info":
	"Internal Error 1012. Please press the [Update] button in license page to correct this problem.
	If the problem persists, please contact our technical support team to resolve this problem","Licensee":"ABC_Backup"
}

OUTPUT 3 - When incorrect License Key was provided

{
	"Status":"Error",
	"Message":"License key incorrect. Please try again."
}

OUTPUT 4 - When AhsayCBS service was stopped

{
	"Status":"OK","Key":"XyZ98-AbcDE-fGhU-98bcd-YZ","Deactivated":false,"Info":"[OEM-License.checkLicTime] License expired on 2024-01-01. Backup server is stopped","Licensee":"ABC_Backup"
}

GetLicense (v1,v2)

This API can be used to collect the license and usage information of your AhsayCBS server.

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

• System Settings > License > Backup

v1 GetLicense.do 

URL

https://CBS.EXAMPLE.COM/cbs/api/json/GetLicense.do

Available Since Version: 8.3

v2 GetLicense.do 

Since AhsayCBS version 8.3, the following add-on modules are combined into one add-on module, to make these modules that were previously separated, interchangeable:

• Hyper-V and VMware (per Guest VM)
• Hyper-V and VMware (per Socket)
• NAS - Synology and NAS - QNAP
• AhsayOBM and AhsayACB Microsoft 365

To facilitate such changes, a new version of the GetLicense.do API (v2 GetLicense.do) was introduced with the following parameters:

For AhsayCBS pre-8.3, you should use the v1 API instead. For all other new versions, use the v2 API to get accurate licensing details.

URL

https://CBS.EXAMPLE.COM/obs/api/json/2/GetLicense.do

Available Since Version: 9.1

Parameters

Return Values

JSON Objects

Licensing Data

Example

INPUT

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

OUTPUT

{
	"Status":"OK",
	"Data":{
		"MobileQuota":"2000",
		"HypervisorSocketQuota":"4000",
		"ExpiryDate":"12/31/2024",
		"RemainMobileV2Quota":"32980",
		"ProductName":"Ahsay Cloud Backup Suite",
		"MaxUsers":"7100",
		"Port":"8081",
		"RemainVMQuota":"22000",
		"LicenseFile":"",
		"RemainObmQuota":"5099",
		"Version":"9.5.4.0",
		"NasQuota":"2010",
		"EnableCbs":true,
		"UsedNasQuota":"2",
		"Licensee":"EvaluationOnly",
		"RemainMobileQuota":"2000",
		"RemainOffice365Quota":"4000",
		"UsedObmQuota":"1",
		"UsedAcbRepQuota":0,
		"RemainAcbRepQuota":2000,
		"MaxObmUsers":"5100",
		"RemainOpenDirectQuota":"2000",
		"EnableUbs":true,
		"Mac":"08-00-27-72-37-A8",
		"RemainAcbQuota":"1999",
		"AcbRepQuota":2000,
		"UsedMobileQuota":"0",
		"RemainNasQuota":"2008",
		"UsedMobileV2Quota":"20",
		"RemainExchangeMailboxQuota":"2000",
		"RemainHypervisorSocketQuota":"4000",
		"Key":"62pMG-YPD6I-3ggaG-b5MCT-XX",
		"EnableHa":false,
		"ObmRepQuota":5100,
		"Description":"",
		"Ip":"127.0.0.1",
		"MaxAcbUsers":"2000",
		"UsedHypervisorSocketQuota":"0",
		"DagUseObm":"0",
		"UsedVMQuota":"0",
		"MobileQuotaV2":"33000",
		"AcbUseObm":"0",
		"UsedExchangeMailboxQuota":"0",
		"RemainObmRepQuota":5100,
		"UsedAcbQuota":"1",
		"OpenDirectQuota":"2000",
		"LicType":4,
		"UseProxy":false,
		"SupExpDate":"12/31/2024",
		"LicTypeName":"OEM License",
		"VMQuota":"22000",
		"Office365Quota":"4000",
		"AcbUseObmRep":0,
		"BrandedProductName":"",
		"UsedOffice365Quota":"0",
		"ExchangeMailboxQuota":"2000",
		"DateFormat":"MM/dd/yyyy",
		"MaxQuota":"UNLIMITED",
		"UsedOpenDirectQuota":"0",
		"UsedObmRepQuota":0
	}
}

GetReplicationMode

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

Return Values

JSON Objects

ReplicationData

Replicator

Example

INPUT

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

OUTPUT

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

AddPredefinedDestination

This API can be used to add (create) a predefined destination on the backup server.

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

• System Settings > Basic > Predefined Destinations

URL

https://CBS.EXAMPLE.COM/obs/api/json/AddPredefinedDestination.do

Available Since Version: 9.7

Parameters

Return Values

JSON Objects

Additional Fields (to merge with return values on error)

Destination Type

Instruction ID

Destination Settings - OBS

Destination Settings - FTP

Destination Settings - SFTP

Destination Settings - Local

Destination Settings - Pooled

Destination Settings - RPS

Destination Settings - Aliyun

Destination Settings - Aliyun Locations

Destination Settings - AWSCompatible

Destination Settings - Azure

Destination Settings - Azure Regions

Destination Settings - Backblaze

Destination Settings - CTYun

Destination Settings - Dropbox

Destination Settings - Google Cloud Storage

Destination Settings - GCS Location Types

Destination Settings - GCS Locations

Destination Settings - Google Drive

Destination Settings - Microsoft OneDrive

Destination Settings - Microsoft OneDrive4Biz

Destination Settings - Microsoft OneDrive4Biz Regions

Destination Settings - OpenStack

Destination Settings - Rackspace

Destination Settings - Rackspace Regions

Destination Settings - Amazon S3

Destination Settings - Amazon S3 Locations

Destination Settings - Amazon S3 Storage Classes

Destination Settings - Wasabi

Destination Settings - Wasabi Locations

Examples

Example 1: Creating a Google Drive Predefined Destination

INPUT

{
	"SysUser":"api_user",
	"SysPwd":"qWeRtY123456!@#$%",
	"Type":"GDrive",
	"SkipVerify":false,
	"DestinationSettings":{
		"Token":"9/abc0e-g5bc2XX2jepVtYRSiA6J4Q03rgVPfssYVu3xhyl9PiHqkiabmwM3i"
	}
}

OUTPUT

{
	"Status":"OK",
	"DestinationID":"-1620712268943"
}

Example 2: Invalid Token for Google Drive Predefined Destination

INPUT

{
	"SysUser":"api_user",
	"SysPwd":"qWeRtY123456!@#$%",
	"Type":"GDrive",
	"DestinationSettings":{
		"Token":"FAKE"
	}
}

OUTPUT

{
	"Status":"Error",
	"Message":"[GDriveManager$GDriveAuthorization.getOAuth2TokensByTempKey] Failed to get Oauth2Tokens after retrieved from GDrive",
	"ExptType":"java.lang.Exception"
}

Example 3: Creating AhsayCBS (OBS) Destination with no 2FA Setup

INPUT

{
	"SysUser":"api_user",
	"SysPwd":"qWeRtY123456!@#$%",
	"Type":"OBS",
	"DestinationSettings":{
		"Immutable":true,
		"TempDelete":true,
		"TempDeleteDate":"2024-08-25",
		"Hour":6,
		"Minute":13
	}
}

OUTPUT

{
	"Status":"Error",
	"Message":"Please setup 2FA devices to proceed with adding immutable destination.",
	"ExptType":"com.ahsay.obs.core.dbs.DbsException"
}