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

Description

Commit/Reschedule an existing upgrade. It moves the upgrade from DRAFT state to SCHEDULED state and/or changes the upgrade scheduled date/time.

Request

Request

URL

URL


patch
https://sfo-vcf01.rainpole.io/v1/upgrades/{upgradeId}
Copy

Path Parameters

Path Parameters

string
upgradeId Required

upgradeId


Request Body

Request Body

UpgradeCommitSpec of type(s) application/json Required

Upgrade Commit/Reschedule Specification

{
	"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 Body

Response Body

200 OK returns Task of type(s) application/json
{
	"completionTimestamp": "string",
	"creationTimestamp": "string",
	"errors": [
		{
			"arguments": [
				"string"
			],
			"causes": [
				{
					"message": "string",
					"type": "string"
				}
			],
			"context": {
				"key": "string"
			},
			"errorCode": "string",
			"errorType": "string",
			"message": "string",
			"nestedErrors": "Error Object",
			"referenceToken": "string",
			"remediationMessage": "string"
		}
	],
	"id": "string",
	"isCancellable": false,
	"localizableDescriptionPack": {
		"arguments": [
			"string"
		],
		"component": "string",
		"message": "string",
		"messageKey": "string"
	},
	"name": "string",
	"resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
	"resources": [
		{
			"fqdn": "string",
			"name": "string",
			"resourceId": "string",
			"sans": [
				"string"
			],
			"type": "string"
		}
	],
	"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
	"subTasks": [
		{
			"completionTimestamp": "string",
			"creationTimestamp": "string",
			"description": "string",
			"errors": [
				{
					"arguments": [
						"string"
					],
					"causes": [
						{
							"message": "string",
							"type": "string"
						}
					],
					"context": {
						"key": "string"
					},
					"errorCode": "string",
					"errorType": "string",
					"message": "string",
					"nestedErrors": "Error Object",
					"referenceToken": "string",
					"remediationMessage": "string"
				}
			],
			"name": "string",
			"resources": [
				{
					"fqdn": "string",
					"name": "string",
					"resourceId": "string",
					"sans": [
						"string"
					],
					"type": "string"
				}
			],
			"stages": [
				{
					"completionTimestamp": "string",
					"creationTimestamp": "string",
					"description": "string",
					"errors": [
						{
							"arguments": [
								"string"
							],
							"causes": [
								{
									"message": "string",
									"type": "string"
								}
							],
							"context": {
								"key": "string"
							},
							"errorCode": "string",
							"errorType": "string",
							"message": "string",
							"nestedErrors": "Error Object",
							"referenceToken": "string",
							"remediationMessage": "string"
						}
					],
					"name": "string",
					"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
					"type": "string"
				}
			],
			"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
			"subTasks": "SubTask Object",
			"type": "string"
		}
	],
	"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.


localizableDescriptionPack Introduced Changed 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

Errors

404

Upgrade not found


500

Internal Server Error

Code Samples

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 (4.4.0)","version":"latest"},{"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
Feedback

Was this page helpful?