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

Update License Keys On Resources

Description

Update license keys of resources

Request

URL

put

https://sfo-vcf01.rainpole.io/v1/resources/licensing-infos

Copy

Request Body

LicensingSpec of type(s) application/json Required

License Information of resources

Show optional properties

{
	"resourceLicensingInfos": [
		{
			"resourceInfo": {
				"domainId": "f0bf0f65-f719-4c2d-980a-29a9094045b5"
			}
		}
	]
}

{
	"resourceLicensingInfos": [
		{
			"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"
			}
		}
	]
}

array of ResourceLicensingInfo

resourceLicensingInfos Required

List of LicensingInfos of resources

Response

200 OK Response Body>

Response Body

200 OK

Returns Task of type(s) application/json

{
    "resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
    "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED, COMPLETED_WITH_WARNING, SKIPPED",
    "type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}

string

completionTimestamp Optional

Task completion timestamp

string

creationTimestamp Optional

Task creation timestamp

array of Error

errors Optional

List of errors in case of a failure

string

id Optional

Task ID

boolean

isCancellable Optional

Represents task can be cancellable or not.

MessagePack

localizableDescriptionPack Optional

Localizable Task description

string

name Optional

Task name

string

resolutionStatus Optional

Resolution state

array of Resource

resources Optional

List of resources associated with task

string

status Optional

Task status

array of SubTask

subTasks Optional

List of sub-tasks of the task

string

type Optional

Operation that is represented by the Task in machine readable format. The value is controlled by the owners/producers of the Task. The convention is _

202 Accepted Response Body>

Response Body

202 Accepted

Returns Task of type(s) application/json

{
    "resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
    "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED, COMPLETED_WITH_WARNING, SKIPPED",
    "type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}

string

completionTimestamp Optional

Task completion timestamp

string

creationTimestamp Optional

Task creation timestamp

array of Error

errors Optional

List of errors in case of a failure

string

id Optional

Task ID

boolean

isCancellable Optional

Represents task can be cancellable or not.

MessagePack

localizableDescriptionPack Optional

Localizable Task description

string

name Optional

Task name

string

resolutionStatus Optional

Resolution state

array of Resource

resources Optional

List of resources associated with task

string

status Optional

Task status

array of SubTask

subTasks Optional

List of sub-tasks of the task

string

type Optional

Operation that is represented by the Task in machine readable format. The value is controlled by the owners/producers of the Task. The convention is _

Errors

Error

400

Bad Request

Error

500

Internal server error

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"resourceLicensingInfos":[{"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/licensing-infos

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

Update License Keys On Resources

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?