List all Patches for device

Base URL

https://{SERVER}/api/?apikey={yourAPIkey}&service=patch_list_all

Description

Lists all software patches for the specified device.

Parameters

Required parameters

Add required parameters immediately after the base URL.

https://{SERVER}/api/?apikey={yourAPIkey}&service=patch_list_all&required_parameters={parameter-value}

Parameter	Description	Type	Options	Default
deviceid	The deviceid must be a valid id.	number	0	0

Optional parameters

Add optional parameters after the required parameters in the base URL.

https://{SERVER}/api/?apikey={yourAPIkey}&service=patch_list_all&required_parameters={parameter-value}&optional_parameters={parameter-value}

Parameter	Description	Type	Options	Default
describe	Optional. Returns a description of the entered call, the available parameters, an example of its output, and returned fields with descriptions.	boolean	true	0

Determine parameter values

Use the following associated service calls to determine parameter values.

Parameter	Call	URL Format
deviceid	list_devices_at_client	https://`{SERVER}`/api/?apikey=`{yourAPIkey}`&service=list_devices_at_client&clientid=CLIENTID&devicetype=server
	list_servers	https://`{SERVER}`/api/?apikey=`{yourAPIkey}`&service=list_servers&siteid=SITEID
	list_workstations	https://`{SERVER}`/api/?apikey=`{yourAPIkey}`&service=list_workstations&siteid=SITEID
siteid	list_sites	https://`{SERVER}`/api/?apikey=`{yourAPIkey}`&service=list_sites&clientid=CLIENTID
clientid	list_clients	https://`{SERVER}`/api/?apikey=`{yourAPIkey}`&service=list_clients

Examples

List all patches for a device

https://{SERVER}/api/?apikey={yourAPIkey}&service=patch_list_all&deviceid=DEVICEID

Example response

<?xml version="1.0" encoding="ISO-8859-1"?>
<patches>
  <patch>
    <patchid>681806</patchid>
    <policy>4</policy>
    <policyLabel><![CDATA[Do Nothing]]></policyLabel>
    <patchicon><![CDATA[aw-image-patch-installed]]></patchicon>
    <status>8</status>
    <selectpatch><![CDATA[checkhide]]></selectpatch>
    <statusLabel><![CDATA[Installed]]></statusLabel>
    <patchUrl><![CDATA[https://www.adobe.com/devnet-docs/xxxxxxx]]></patchUrl>
    <patchTitle><![CDATA[Adobe Reader DC (64-bit) (x64) 24.2.20965]]></patchTitle>
    <product><![CDATA[Adobe Reader DC (64-bit)]]></product>
    <severity>3</severity>
    <severityLabel><![CDATA[Moderate]]></severityLabel>
    <releaseDate>1722380400</releaseDate>
    <releaseDateText><![CDATA[31-Jul-2024]]></releaseDateText>
    <installDate>1722384000</installDate>
    <installDateText><![CDATA[31-Jul-2024 00:00]]></installDateText>
    <deployable>1</deployable>
    <uninstallable>1</uninstallable>
    <classification><![CDATA[Other Vendor]]></classification>
  </patch>
  <patch>
    <!-- more <patch> nodes -->
  </patch>
</patches>

Returned fields

Field	Type	Can Be Empty	Description
patchid	integer	no	The unique identifier of the patch.
policy	integer	no	Manual approval policy setting: 1 = Ignored at var/site/client level 2 = Approved for patch installation at var/site/client level 4 = Do nothing on var/site/client level or inherit auto-approval from patch policy 65 = Ignored patch on device level 66 = Approve for install patch on device level 68 = Do nothing at device level.
patchicon	string	yes	Generalized status icon. Possible values: aw-image-patch-failed aw-image-patch-installed aw-image-patch-missing aw-image-patch-pending aw-image-patch-installing aw-image-patch-ignored.
status	integer	no	Patch status bit flags: 0x01 = Missing 0x02 = Pending 0x04 = Queued 0x08 = Installed 0x10 = Failed 0x20 = Ignored.
selectpatch	string	yes	Will be empty if the patch status is Missing Pending Ignored Failed Otherwise shows `checkhide` for all other statuses
statusLabel	string	no	Installation status label. One of: Missing Pending Queued Installed Failed Ignored.
patchUrl	string	yes	External link to the patch description, for example https://support.microsoft.com/kb/979441.
patchTitle	string	no	Title or name of the patch, for example Security Update for Microsoft Office InfoPath 2007 (KB979441).
product	string	no	Product identifier, for example Office.
severity	integer	yes	Severity rating: 1 = Critical 2 = Important 3 = Moderate 4 = Low. See the Microsoft Security Response Center severity rating system.
severityLabel	string	yes	Severity level name: Critical Important Moderate Low. See the Microsoft Security Response Center severity rating system.
releaseDate	int	yes	Patch release date and time as a timestamp.
releaseDateText	datetime	yes	Patch release date and time in human-readable format, for example 31‑Jul‑2024.
installdate	int	yes	Installation date and time as a timestamp.
installdatetext	datetime	yes	Installation date and time in human-readable format, for example 31‑Jul‑2024.