License

The /License resource collection represents all license instances that are currently installed.

Get License Information

The HTTP GET request to the /license endpoint retrieves information about the currently installed license, including its status, socket counts and expiration dates.

SecurityuserAuth

Responses

200

401

Unauthorized

500

Internal Server Error

get/api/v1/license

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"status": "Licensed",
"company": "Contoso Ltd.",
"hypervSockets": {"total": 16,
"used": 4
},
"vSphereSockets": {"total": 32,
"used": 12
},
"expirationDate": {"date": "2027-06-15T00:00:00Z",
"daysRemaining": 421
},
"supportExpirationDate": {"date": "2027-06-15T00:00:00Z",
"daysRemaining": 421
},
"licenseType": "Subscription",
"licensePlatform": "Hyper-V and VMware",
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@contoso.com",
"version": "5.0"
}

Install License

The HTTP POST request to the /license/install endpoint installs a license from the license file content specified in the request body. The content must be specified in the Base64 format.

SecurityuserAuth

Request

Request Body schema: application/json

licenseContent

required

string non-empty

Content of the license file in the Base64 format.

Responses

204

No Content

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/api/v1/license/install

Request samples

application/json

{"licenseContent": "QmFzZTY0LWVuY29kZWQgbGljZW5zZSBjb250ZW50Lg=="
}

Response samples

application/json

{"message": "string"
}