List all Patches for device
Use this API Call to query our Data Extraction API to extract data gathered by N-sight RMM.This section shows the service name and parameters needed in the API Call query, and provides examples of some queries and system responses. For more information, see Data Extraction API.
|
Service name: patch_list_all |
|
|
URL |
https://SERVER/api/?apikey=yourAPIkey&service=patch_list_all &required_parameters=required_parameters [&optional_parameters=optional_parameters] |
|
Description |
Lists all software patches for the specified device. |
|
Parameters |
|||||
|
Post Variable |
Description |
Type |
Required |
Options |
Default |
|
Optional. Returns a description of the service. |
boolean |
no |
true |
0 |
|
|
deviceid |
The deviceid must be a valid id. |
number |
yes |
0 |
0 |
|
Example Service Call =patch_list_all |
|
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> ... </patch> </patches> |
|
Field Descriptions |
|||
|
Field |
Type |
Can Be Empty |
Description |
|
patchid |
integer |
no |
The unique identifier of the patch |
|
policy |
integer |
no |
Manual approval policy setting: 1 - Ignored patch on var/site/client level 2 - Approved for installation patch on var/site/client level 4 - Do nothing on var/site/client level or Inherit autoapproval rule from patch policy 65 - Ignored patch on device level 66 - Approve for install patch on device level 68 - Do nothing on device level |
|
patchicon |
string |
yes |
Generalized status icon: |
|
status |
integer |
no |
The patch status (bit flags) |
| selectpatch | string | yes |
Will be empty if the patch status is : Missing otherwise will show as 'checkhide' for all other statuses |
|
statusLabel |
string |
no |
Installation status: |
|
patchUrl |
string |
yes |
External link to patch description, for example: |
|
patchTitle |
string |
no |
Title/name of the patch, for example: |
|
product |
string |
no |
Product identifier, for example: |
|
severity |
integer |
yes |
The severity of the vulnerability the patch addresses. |
|
severityLabel |
string |
yes |
Severity level name. |
|
releaseDate |
int |
yes |
Patch release date/time (timestamp) |
|
releaseDateText |
datetime |
yes |
Patch release date/time human format, for example: |
|
installdate |
int |
yes |
Installation date/time (timestamp) |
|
installdatetext |
datetime |
yes |
Installation date/time human format, for example: |
| Example Associated Service Calls | ||
| 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 |