This API has a deprecated equivalent from v7.0U1.
List Pending
Checks if new updates are available.
Request
URLURL
https://{api_host}/api/appliance/update/pending
Query Parameters
Query Parameters
string
url
Optional
specific URL to check at If unset then URL is taken from the policy settings
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
array of
UpdateSummary of type application/json
List of the update summaries
[
{
"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": "HIGH",
"reboot_required": false,
"release_date": "string",
"severity": "CRITICAL",
"size": 0,
"update_type": "SECURITY",
"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.
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.
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.
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
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-ListUpdatePending -SourceType "LAST_CHECK" -Url "MyUrl"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/appliance/update/pending?source_type=string
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
x-vmw-doc-operation: list
Availability
Added in 7.0U2
On This Page
Pending Operations
get
get
post
post
post
post
