Get License Key
Retrieve a license key
The 29 alpha numeric character license key with hyphens
4J6TH-3XK57-480X4-0E9H6-2X00PSuccessful
{
"id": "string",
"key": "XX0XX-XX0XX-XX0XX-XX0XX-XX0XX ",
"productType": "One among: VCENTER, VSAN, ESXI, NSXT, WCP",
"description": "string",
"productVersion": "string",
"isUnlimited": false,
"licenseKeyUsage": {
"total": 0,
"remaining": 0,
"used": 0,
"licenseUnit": "One among: CPUPACKAGE, INSTANCE, VMS, CCU, PLU, DESKTOPVM, SERVERVM, VM, SERVER, CORES, CONCURRENTUSER, NAMEDUSER, CPUCORE, TIB"
},
"licenseKeyValidity": {
"licenseKeyStatus": "One among: EXPIRED, ACTIVE, NEVER_EXPIRES",
"expiryDate": "string"
},
"features": [
"string"
],
"licenseEdition": "string",
"licenseUnit": "string",
"minimumCore": 0
}The ID of the license key
The 29 alpha numeric character license key with hyphens
The type of the product to which the license key is applicable
Description of the license key given by user
Product version
Indicates if the license key has unlimited usage
Defines license key usage
Defines license key validity details
License key features
License key edition
License capacity unit
The minimum number of core licenses required per CPU, when license unit is cpu core
License key not found
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
Detailed results of the precheck validation.
The localized error message
The localized remediation error message
The underlying cause exceptions.
The nested errors when the error is a composite one
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized label message
The URL string for remediation documentation link
Internal server error
"Error Object"The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
Detailed results of the precheck validation.
The localized error message
The localized remediation error message
The underlying cause exceptions.
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized label message
The URL string for remediation documentation link
curl -H 'Authorization: <value>' https://{api_host}/v1/license-keys/{key}