Get License Keys

Get License Keys

Retrieve a list of license keys

Request
URI
GET
https://{api_host}/v1/license-keys
COPY
Query Parameters
string of array
productType
Optional

Type of a Product

productType example 
NSXV,VCENTER
string of array
licenseKeyStatus
Optional

Status of a License Key

licenseKeyStatus example 
EXPIRED,ACTIVE
string of array
licenseUnit
Optional

Unit of a license

licenseUnit example 
CPUPACKAGE, CORE
string
productVersion
Optional

Product Version, gets the license keys matching the major version of the product version

productVersion example 
6,7.0.3,8.0
Responses
200

Successful

Returns PageOfLicenseKey of type(s) application/json 
{
    "elements": [
        {
            "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
        }
    ],
    "pageMetadata": {
        "pageNumber": 0,
        "pageSize": 0,
        "totalElements": 0,
        "totalPages": 0
    }
}
array of object
elements
Optional

The list of elements included in this page

object
pageMetadata
Optional

Represents pageable elements pagination metadata


500

Internal server error

Returns Error of type(s) application/json 
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

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
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

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.


Code Samples
COPY 
                    curl -H 'Authorization: <value>' https://{api_host}/v1/license-keys
On This Page
License Keys Operations
PUT
Set License Key For Resource
POST
Start License Check By Resource
GET
Get License Keys
POST
Add License Key
PATCH
Update License Key
GET
Get License Check Result By ID
GET
Get License Information
GET
Get System Licensing Info
GET
Get Domain Licensing Info
GET
Get License Key
DELETE
Remove License Key
GET
Get License Product Types