Get License Keys

Get License Keys

Retrieve a list of 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
    }
}
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) */* 
{
    "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.

array of ErrorCause
causes
Optional

The underlying cause exceptions.

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

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.

string
remediationMessage
Optional

The localized remediation error message


On This Page
License Keys Operations
POST
Add License Key
GET
Get License Check Result By ID
GET
Get License Information
GET
Get License Key
GET
Get License Keys
DELETE
Remove License Key
PUT
Set License Key For Resource
POST
Start License Check By Resource
PATCH
Update License Information