This API has a deprecated equivalent from v7.0U1.
Get Staged
Gets the current status of the staged update
Request
URLURL
https://{api_host}/api/appliance/update/staged
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
UpdateStagedInfo of type application/json
Info structure with information about staged update
{
"description": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"name": "string",
"priority": "enum",
"reboot_required": false,
"release_date": "string",
"severity": "enum",
"size": 0,
"staging_complete": false,
"update_type": "enum",
"version": "string"
}
description
Required
Description of the update. The short information what this update is. E.g. “Update2 for vCenter Server Appliance 6.5”
string
name
Required
Name of the update.
boolean
reboot_required
Required
Flag indicating whether reboot is required after update.
string
release_date
Required
Update release date.
severity
Required
Update severity
Possible values are: CRITICAL , IMPORTANT , MODERATE , LOW
integer
size
Required
Download Size of update in Megabytes.
boolean
staging_complete
Required
Is staging complete
update_type
Required
Update category
Possible values are: SECURITY , FIX , UPDATE , UPGRADE
string
version
Required
Version in form of X.Y.Z.P. e.g. 6.5.1.5400 When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.appliance.update.pending. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.appliance.update.pending.
Errors
403
com.vmware.vapi.std.errors.unauthorized : session is not authorized to perform this operation
Code Samples
Code Samples
PowerCLI Client SDK Example
Invoke-GetUpdateStaged
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/appliance/update/staged
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/appliance/update/staged
x-vmw-doc-operation: get
Availability
Added in 7.0U2
On This Page
Staged Operations
get
delete
