This API has a deprecated equivalent from v7.0U1.
Get Pending
Gets update information
Request
URLURL
https://{api_host}/api/appliance/update/pending/{version}
Path Parameters
Path Parameters
string
version
Required
Update version The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.
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
UpdatePendingInfo
of type application/json
{
"contents": [
{
"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"
}
}
}
],
"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"
}
}
},
"eulas": [
{
"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"
}
}
}
],
"knowledge_base": "string",
"name": "string",
"priority": "HIGH",
"reboot_required": false,
"release_date": "string",
"services_will_be_stopped": [
{
"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"
}
}
},
"service": "string"
}
],
"severity": "CRITICAL",
"size": 0,
"staged": false,
"update_type": "SECURITY"
}
array of
StdLocalizableMessage
contents
Required
List of the 1. issues addressed since previous/current version 2. new features/improvements
description
Required
Description of the update. The short information what this update is. E.g. “Update2 for vCenter Server Appliance 6.5”
array of
StdLocalizableMessage
eulas
Required
List of EULAs. This list has multiple entries and can be dynamic based on what we are actually installing.
string
knowledge_base
Required
URL for the knowledge base article describing this update.
string
name
Required
Name of the update.
priority
Required
The CommonInfo.Priority enumerated type defines the update installation priority recommendations.
HIGH : Install ASAP
MEDIUM : Install at the earliest convenience
LOW : Install at your discretion
Possible values are: HIGH , MEDIUM , LOW
boolean
reboot_required
Required
Flag indicating whether reboot is required after update.
string
release_date
Required
Update release date.
array of
UpdateServiceInfo
services_will_be_stopped
Required
List of the services that will be stopped and restarted during the update installation.
severity
Required
The CommonInfo.Severity enumerated type defines the severity of the issues fixed in the update.
CRITICAL : Vulnerabilities that can be exploited by an unauthenticated attacker from the Internet or those that break the guest/host Operating System isolation. The exploitation results in the complete compromise of confidentiality, integrity, and availability of user data and/or processing resources without user interaction. Exploitation could be leveraged to propagate an Internet worm or execute arbitrary code between Virtual Machines and/or the Host Operating System.
IMPORTANT : Vulnerabilities that are not rated critical but whose exploitation results in the complete compromise of confidentiality and/or integrity of user data and/or processing resources through user assistance or by authenticated attackers. This rating also applies to those vulnerabilities which could lead to the complete compromise of availability when exploitation is by a remote unauthenticated attacker from the Internet or through a breach of virtual machine isolation.
MODERATE : Vulnerabilities where the ability to exploit is mitigated to a significant degree by configuration or difficulty of exploitation, but in certain deployment scenarios could still lead to the compromise of confidentiality, integrity, or availability of user data and/or processing resources.
LOW : All other issues that have a security impact. Vulnerabilities where exploitation is believed to be extremely difficult, or where successful exploitation would have minimal impact
Possible values are: CRITICAL , IMPORTANT , MODERATE , LOW
integer
size
Required
Download Size of update in Megabytes.
boolean
staged
Required
Is the update staged
update_type
Required
The CommonInfo.Category enumerated type defines update type
SECURITY : Fixes vulnerabilities, doesn’t change functionality
FIX : Fixes bugs/vulnerabilities, doesn’t change functionality
UPDATE : Changes product functionality
UPGRADE : Introduces new features, significantly changes product functionality
Possible values are: SECURITY , FIX , UPDATE , UPGRADE
Errors
400
com.vmware.vapi.std.errors.already_in_desired_state : if the update of this version is already installed
403
com.vmware.vapi.std.errors.unauthorized : session is not authorized to perform this operation
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetVersionUpdatePending -Version "MyVersion"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/appliance/update/pending/{version}
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/pending/{version}
x-vmw-doc-operation: get
Availability
Added in 7.0U2
On This Page
Pending Operations
get
get
post
post
post
post
