[{"label":"Latest (4.5.0)","version":"latest"},{"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 Upgradables By Domain

Description

Fetches the list of Upgradables for a given domain. If a target version is provided, Upgradables that are required for given target version become Available. The Upgradables providesinformation that can be use for Precheck API and also in the actual Upgrade API call.

Request

Request

URL

URL


get
https://sfo-vcf01.rainpole.io/v1/upgradables/domains/{domainId}
Copy

Path Parameters

Path Parameters

string
domainId Required

Domain ID


Query Parameters

Query Parameters

string
targetVersion Optional

Target Version to get Upgradables for a given Target Release


Response

Response

Response Body

Response Body

200 OK

Returns PageOfUpgradable of type(s) application/json
{
	"elements": [
		{
			"bundleId": "string",
			"bundleType": "string",
			"resource": {
				"fqdn": "string",
				"name": "string",
				"resourceId": "string",
				"sans": [
					"string"
				],
				"type": "string"
			},
			"softwareComponents": [
				{
					"id": "string",
					"type": "string"
				}
			],
			"status": "string"
		}
	],
	"pageMetadata": {
		"pageNumber": 0,
		"pageSize": 0,
		"totalElements": 0,
		"totalPages": 0
	}
}
array of Upgradable
elements Optional

The list of elements included in this page


pageMetadata Optional

Pageable elements pagination metadata information

Errors

Errors

404

Domain not found


500

Internal Server Error

Code Samples

Code Samples

cURL Command

curl https://sfo-vcf01.rainpole.io/v1/upgradables/domains/{domainId}


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

Was this page helpful?