Get License Keys
Get the License Keys
Request
URI
GET
https://sfo-vcf01.rainpole.io/v1/license-keys
COPY
Query Parameters
string of array
productType
Optional
Type of a Product
string of array
licenseKeyStatus
Optional
Status of a License Key
string
productVersion
Optional
Product Version, gets the license keys matching the major version of the product version
Responses
200
Successful
Returns PageOfLicenseKey of type(s) */*
{
"elements": [
{
"description": "string",
"id": "string",
"isUnlimited": false,
"key": "XX0XX-XX0XX-XX0XX-XX0XX-XX0XX ",
"licenseKeyUsage": {
"licenseUnit": "One among: CPUPACKAGE, INSTANCE, VMS, CCU, PLU, DESKTOPVM, SERVERVM, VM, SERVER, CORES, CONCURRENTUSER, NAMEDUSER, CPUCORE",
"remaining": 0,
"total": 0,
"used": 0
},
"licenseKeyValidity": {
"expiryDate": "string",
"licenseKeyStatus": "One among: EXPIRED, ACTIVE, NEVER_EXPIRES"
},
"productType": "One among: VCENTER, VSAN, SDDC_MANAGER, ESXI, NSXT, NSXIO, WCP, HORIZON_VIEW",
"productVersion": "string"
}
],
"pageMetadata": {
"pageNumber": 0,
"pageSize": 0,
"totalElements": 0,
"totalPages": 0
}
}
500
Internal server error
Returns Error of type(s) */*
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}array of string
arguments
Optional
The arguments used to localize the message, Can be used by scripts to automate the error processing.
object
context
Optional
The error context (e.g. the component where it occurred).
string
errorCode
Optional
The minor error code
string
errorType
Optional
The error type
string
message
Optional
The localized error message
string
referenceToken
Optional
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
string
remediationMessage
Optional
The localized remediation error message