Zerto Virtual Replication APIs : License API : View License Details
  
View License Details
Retrieve information about a Zerto Virtual Replication license.
 
method
url
GET
https://zvm_ip:port/v1/license
 
 
Where:
 
zvm_ip
The IP address of the Zerto Virtual Manager where the API is run.
port
The port to access the Zerto Virtual Manager. The default port is 9669.
Request
The request body is empty.
Response
The following is an example of a Json response for https://zvm_ip:port/v1/license.
 
{
  "Details": {
    "ExpiryTime": "2021-01-01T00:00:00.000Z",
    "LicenseKey": "L8D5VK6EUVXWT33STH9YHR3GQ4YW3FPCWJECLR2",
    "LicenseType": "",
    "MaxVms": 1000
  },
  "Usage": {
    "SitesUsage": [
      {
        "ProtectedVmsCount": 6,
        "SiteIdentifier": "939558e2-e2b7-4a7c-980b-92db337c14b1",
        "SiteName": "QA_VC_118.234"
      },
      {
        "ProtectedVmsCount": 3,
        "SiteIdentifier": "1289edfe-4cc7-4d68-8293-ca960e82d224",
        "SiteName": "QA_HV_143.230"
      },
    ],
  "TotalVmsCount": 9
  }
}
 
Parameter
Description
Details
General information about the license.
ExpiryTime
The date and time on which the license expires, according to the Zerto Virtual Manager clock where the API is run.
The time is in the format yyyy-mm-ddThh:mm:ss, set to UTC.
LicenseKey
The license key.
LicenseType
The type of license.
MaxVms
The maximum number of virtual machines that can be protected that can be used with this license, based on the license type.
Usage
Information about the sites using the license.
ProtectedVMsCount
The number of protected VMs in the site.
SiteIdentifier
The identifier of the site.
SiteName
The name of the site.
TotalVmsCount
The total number of VMs used in all the sites that are linked to a single license.
Back to License API
Back to All APIs