License API

Important: This document is being phased out and does not contain up-to-date information. For updated API documentation for Zerto versions 9.5 and later, see ZVM REST API - Swagger.

You can also access Swagger from the ZVM: click the menu button () on the top right and select APIs or navigate to https://<ZVM IP>:9669/swagger/index.html in a Windows ZVM or https://<ZVM IP>/management/api/swagger/index.html in ZVM Appliance.

Use the license API to retrieve information about the license and perform actions related to the license.

Using the license API, you can:

•

Integrate the license information into portals.

•

Activate environments automatically.

•

Automatically monitor quantity and usage.

Required Privileges: Manage site permission.

The following APIs are available:

View License Details

Apply a New License or Update an Existing License

Delete a License

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 Body Using Json Format

The request body is empty.

Response In Json Format

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": "L8D5VK6EUVXWT33STH9YHR3GQ4K6JYW3FPCWJECLR2",
    "LicenseType": "",
    "MaxVms": 1000
  },
  "Usage": {
    "SitesUsage": [
      {
        "ProtectedVmsCount": 6,
        "SiteIdentifier": "939558e2-e2b7-4a7c-980b-92db337c14b1",
        "SiteName": "QA_VC_Noa_118.234"
      },
      {
        "ProtectedVmsCount": 3,
        "SiteIdentifier": "1289edfe-4cc7-4d68-8293-ca960e82d224",
        "SiteName": "String content"
      },
    ],
  "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.fffZ, set to UTC.
LicenseKey	The license key.
LicenseType	The type of the 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.
SitesUsage	Details about the sites and the protected VMs in each site.
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

Apply a New License or Update an Existing License

Add a new license or update an existing one.

Method	URL
PUT	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 Body Using Json Format

The following is an example of a Json request body for https://zvm_ip:port/v1/license.

{
"LicenseKey": "L8D5VK6EUVXWT33STH9YHR3GQ4K6JYW3FPCWJECLR2"
}

Parameter	Description	Type	Mandatory
LicenseKey	The license key.	string	Yes

Response In Json Format

The response body is empty.

Back to License API

Back to All APIs

Delete a License

Delete a ZVM license.

Method	URL
DELETE	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 Body Using Json Format

The request body is empty.

Response In Json Format

The response body is empty.

Back to License API

Back to All APIs