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

Check Resources License

Description

Check resources license

Request

URL

post

https://sfo-vcf01.rainpole.io/v1/resources/license-checks

Copy

Request Body

ResourcesLicenseCheckSpec of type(s) application/json Required

Resources license check spec

{
	"forAllDomains": false,
	"licenseCheckResources": [
		{
			"productInfo": {
				"errorResponse": {
					"arguments": [
						"string"
					],
					"causes": [
						{
							"message": "string",
							"type": "string"
						}
					],
					"context": {
						"key": "string"
					},
					"errorCode": "string",
					"errorType": "string",
					"message": "string",
					"nestedErrors": "Error Object",
					"referenceToken": "string",
					"remediationMessage": "string"
				},
				"licenseKey": "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
				"licenseKeyExpirationDate": "2021-04-08T04:37:51.662Z",
				"licenseKeyStatus": "One among: EXPIRED, ACTIVE, NEVER_EXPIRES",
				"licensingMode": "One among: SUBSCRIPTION, PERPETUAL",
				"type": "One among: VCENTER, NSXT, VSAN, WCP, ESXI"
			},
			"resourceInfo": {
				"clusterId": "a0bf0f65-f719-4c2d-980a-29a9094045b5",
				"domainId": "f0bf0f65-f719-4c2d-980a-29a9094045b5",
				"hostId": "b0bf0f65-f719-4c2d-980a-29a9094045b5"
			}
		}
	]
}

boolean

forAllDomains Optional

Value that defines whether to get license check for all domains or not

array of LicenseCheckResource

licenseCheckResources Optional

A list of resources for which license check needs to be performed

Response

200 OK Response Body>

Response Body

200 OK

Returns ResourcesLicenseCheckResult of type(s) */*

{
    "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED, COMPLETED_WITH_WARNING, SKIPPED"
}

string

endTimestamp Optional

Task end timestamp

string

id Optional

ID of the resources license check task

array of ResourceLicensingInfo

resourceLicensingInfos Optional

List of licensing infos of resources

string

startTimestamp Optional

Task start timestamp

string

status Optional

Task status

202 Accepted Response Body>

Response Body

202 Accepted

Returns ResourcesLicenseCheckResult of type(s) */*

{
    "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED, COMPLETED_WITH_WARNING, SKIPPED"
}

string

endTimestamp Optional

Task end timestamp

string

id Optional

ID of the resources license check task

array of ResourceLicensingInfo

resourceLicensingInfos Optional

List of licensing infos of resources

string

startTimestamp Optional

Task start timestamp

string

status Optional

Task status

Errors

Error

400

Bad Request

Error

500

Internal server error

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"forAllDomains":false,"licenseCheckResources":[{"productInfo":{"errorResponse":{"arguments":["string"],"causes":[{"message":"string","type":"string"}],"context":{"key":"string"},"errorCode":"string","errorType":"string","message":"string","nestedErrors":"Error Object","referenceToken":"string","remediationMessage":"string"},"licenseKey":"XXXXX-XXXXX-XXXXX-XXXXX-XXXXX","licenseKeyExpirationDate":"2021-04-08T04:37:51.662Z","licenseKeyStatus":"One among: EXPIRED, ACTIVE, NEVER_EXPIRES","licensingMode":"One among: SUBSCRIPTION, PERPETUAL","type":"One among: VCENTER, NSXT, VSAN, WCP, ESXI"},"resourceInfo":{"clusterId":"a0bf0f65-f719-4c2d-980a-29a9094045b5","domainId":"f0bf0f65-f719-4c2d-980a-29a9094045b5","hostId":"b0bf0f65-f719-4c2d-980a-29a9094045b5"}}]}' https://sfo-vcf01.rainpole.io/v1/resources/license-checks

vcf-for-vxrail

What's changed in 5.0.0?

INTRODUCED

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

Check Resources License

Request

URL

Request Body

Response

Response Body

200 OK

Response Body

202 Accepted

Errors

Code Samples

cURL Command

What's changed in 5.0.0?

On This Page

License Keys Operations

Was this page helpful?