[{"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 Upgrades
DescriptionGet Upgrades
Request
URLURL
https://sfo-vcf01.rainpole.io/v1/upgrades
Query Parameters
Query Parameters
string
bundleId
Optional
Bundle Id for the upgrade
string
status
Optional
Status of the upgrades you want to retrieve
Response
Response
Response BodyResponse Body
200 OK
Returns
PageOfUpgrade
of type(s) application/json
{
"elements": [
{
"bundleId": "string",
"id": "string",
"nsxtUpgradeUserInputSpec": {
"nsxtEdgeClusterUpgradeSpecs": [
{
"edgeClusterId": "string",
"edgeParallelUpgrade": false
}
],
"nsxtHostClusterUpgradeSpecs": [
{
"hostClusterId": "string",
"hostParallelUpgrade": false,
"liveUpgrade": false
}
],
"nsxtId": "string",
"nsxtUpgradeOptions": {
"isEdgeClustersUpgradeParallel": false,
"isEdgeOnlyUpgrade": false,
"isHostClustersUpgradeParallel": false
}
},
"parallelUpgrade": false,
"resourceType": "One among: DOMAIN, CLUSTER, UNASSIGNED_HOST",
"resourceUpgradeSpecs": [
{
"customISOSpec": {
"hostIds": [
"string"
],
"id": "string"
},
"enableQuickboot": false,
"evacuateOfflineVms": false,
"personalitySpec": {
"hardwareSupportSpecs": [
{
"name": "string",
"packageSpec": {
"name": "string",
"version": "string"
}
}
],
"personalityId": "string"
},
"resourceId": "string",
"scheduledTimestamp": "string",
"shutdownVms": false,
"toVersion": "string",
"upgradeNow": false
}
],
"status": "string",
"taskId": "string"
}
],
"pageMetadata": {
"pageNumber": 0,
"pageSize": 0,
"totalElements": 0,
"totalPages": 0
}
}
Errors
Error
404
Upgrade not found
Error
500
Internal Server Error
Code Samples
cURL Command
curl https://sfo-vcf01.rainpole.io/v1/upgrades
[{"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
On This Page
Upgrades Operations
get
get
post
post