[{"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
Commit Reschedule Upgrade
DescriptionCommit/Reschedule an existing upgrade. It moves the upgrade from DRAFT state to SCHEDULED state and/or changes the upgrade scheduled date/time.
Request
URLURL
https://sfo-vcf01.rainpole.io/v1/upgrades/{upgradeId}
Path Parameters
Path Parameters
string
upgradeId
Required
upgradeId
Request Body
Request Body
{
"scheduledTimestamp": "string",
"upgradeNow": false
}
string
scheduledTimestamp
Optional
Upgrade Scheduled Time
boolean
upgradeNow
Optional
Flag for enabling Upgrade Now. If true, scheduledTimestamp is ignored
Response
Response
Response BodyResponse 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
string
id
Optional
Task ID
boolean
isCancellable
Optional
Represents task can be cancellable or not.
string
name
Optional
Task name
string
resolutionStatus
Optional
Resolution state
string
status
Optional
Task status
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
404
Upgrade not found
Error
500
Internal Server Error
Code Samples
cURL Command
curl -X PATCH -H "Content-Type: application/json" -d '{"scheduledTimestamp":"string","upgradeNow":false}' https://sfo-vcf01.rainpole.io/v1/upgrades/{upgradeId}
[{"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
On This Page
Upgrades Operations
get
post
