List systems with patch scan status
patch_scan_detailsRetrieve patch scan status and health for all managed systems, including scan remarks, timestamps, and agent details. Filter by platform, domain, health, or live status, with pagination.
Instructions
Retrieves all systems with their patch scan status (success/failed/in progress/not scanned), scan remarks, last scan times, agent details, and patch health. Supports filtering and pagination.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| raw | No | Return the full, unprojected record for each row instead of the curated default field set. | |
| page | No | Page number to retrieve. Default is 1. | |
| resId | No | Filter to the system with this resource_id. | |
| pageLimit | No | Max records per page (server cap is 1000). Defaults to the server's configured default page size. | |
| domainFilter | No | Filter by NetBIOS domain name (domain list is available from the desktop serverproperties API). | |
| healthFilter | No | Filter by system patch health: 0 Unknown (patch status not available), 1 Healthy (up-to-date), 2 Vulnerable (has missing patches), 3 Highly Vulnerable (has critical or high-risk missing patches). | |
| platformFilter | No | Filter by OS platform: Windows, Mac, or Linux. | |
| liveStatusFilter | No | Filter by agent live status: 1 Agent Live (running), 2 Agent Down (not responding). | |
| customGroupFilter | No | Filter by custom group (list available from the desktop serverproperties API). | |
| branchOfficeFilter | No | Filter by remote/branch office name (list available from the desktop serverproperties API). | |
| agentInstallationStatusFilter | No | Filter by agent installation status: 21 Not Installed, 22 Installed. |