[{"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/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]

vcf

Add License Key

Description

Add a License Key

Request

URL

post

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

Copy

Request Body

LicenseKey of type(s) application/json Required

License key with other attributes

Show optional properties

{
    "key": "XX0XX-XX0XX-XX0XX-XX0XX-XX0XX ",
    "productType": "One among: VCENTER, VSAN, SDDC_MANAGER, ESXI, NSXT, NSXIO, WCP, HORIZON_VIEW"
}

{
    "key": "XX0XX-XX0XX-XX0XX-XX0XX-XX0XX ",
    "productType": "One among: VCENTER, VSAN, SDDC_MANAGER, ESXI, NSXT, NSXIO, WCP, HORIZON_VIEW"
}

string

description Required

Description of the license key given by user

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

licenseKeyUsage Optional

License key usage details

LicenseKeyValidity

licenseKeyValidity Optional

License key validity details

string

productVersion Introduced Optional

Product version

Response

200 OK Response Body>

Response Body

200 OK

Returns LicenseKey of type(s) */*

{
    "key": "XX0XX-XX0XX-XX0XX-XX0XX-XX0XX ",
    "productType": "One among: VCENTER, VSAN, SDDC_MANAGER, ESXI, NSXT, NSXIO, WCP, HORIZON_VIEW"
}

string

description Required

Description of the license key given by user

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

licenseKeyUsage Optional

License key usage details

LicenseKeyValidity

licenseKeyValidity Optional

License key validity details

string

productVersion Introduced Optional

Product version

201 Created Response Body>

Response Body

201 Created

Returns LicenseKey of type(s) */*

{
    "key": "XX0XX-XX0XX-XX0XX-XX0XX-XX0XX ",
    "productType": "One among: VCENTER, VSAN, SDDC_MANAGER, ESXI, NSXT, NSXIO, WCP, HORIZON_VIEW"
}

string

description Required

Description of the license key given by user

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

licenseKeyUsage Optional

License key usage details

LicenseKeyValidity

licenseKeyValidity Optional

License key validity details

string

productVersion Introduced Optional

Product version

Errors

Error

500

Internal server error

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"key":"XX0XX-XX0XX-XX0XX-XX0XX-XX0XX ","productType":"One among: VCENTER, VSAN, SDDC_MANAGER, ESXI, NSXT, NSXIO, WCP, HORIZON_VIEW"}' https://sfo-vcf01.rainpole.io/v1/license-keys

vcf

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

Add License Key

Request

URL

Request Body

Response

Response Body

200 OK

Response Body

201 Created

Errors

Code Samples

cURL Command

On This Page

License Keys Operations

Was this page helpful?