Get License Keys | VMware Cloud Foundation API

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 LicenseKey

elements

Optional

The list of elements included in this page

PageMetadata

pageMetadata

Optional

Represents pageable elements pagination metadata

500

Internal server error

Returns Error of type(s) application/json

{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}

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.