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