[{"label":"Latest (4.4.0)","version":"latest"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail

Get License Key

Description

Get a License Key by key

Request

Request

URL

URL


get
https://sfo-vcf01.rainpole.io/v1/license-keys/{key}
Copy

Path Parameters

Path Parameters

string
key Required

The 29 alpha numeric character license key with hyphens


Response

Response

Response Body

Response Body

200 OK returns LicenseKey of type(s) */*
{
	"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",
		"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, WCP, HORIZON_VIEW"
}
string
description Required

Description of the license key


string
key Required

The 29 alpha numeric character license key with hyphens


string
productType Required

The type of the product to which the license key is applicable


string
id Optional

The ID of the license key


boolean
isUnlimited Optional

Indicates if the license key has unlimited usage


licenseKeyUsage Optional

License key usage details


licenseKeyValidity Optional

License key validity details

Errors

Errors

404

License key not found


500

Internal server error

Code Samples

Code Samples

cURL Command

curl https://sfo-vcf01.rainpole.io/v1/license-keys/{key}


[{"label":"Latest (4.4.0)","version":"latest"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail
Feedback

Was this page helpful?