Introduced1 Changed1

[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"version":"4.4.0"},{"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 Keys

Description

Get the License Keys

Request

URL

get

https://sfo-vcf01.rainpole.io/v1/license-keys

Copy

Query Parameters

array

licenseKeyStatus Optional

Status of a License Key

array

productType Optional

Type of a Product

string

productVersion Optional

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

Response

Response Body

200 OK

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

Pageable elements pagination metadata information

Errors

Error

500

Internal server error

Code Samples

cURL Command

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

vcf-for-vxrail

What's changed in 5.0.0?

CHANGED (1)

INTRODUCED (1)

Added Parameters

productVersion

License Keys Operations

post

Add License Key

post

Check Resources License Introduced

delete

Delete License Key

get

Get License Key

get

Get License Keys Changed

get

Get Licensing Info

get

Get Resources License Check Result Introduced

put

Update License Keys On Resources Introduced