Retrieve missing patches.

Retrieves published patches not installed on the devices on the network.

get/api/v1/accounts/{accountId}/patchavailability

Request

Path parameters

accountIdstring required

Your WatchGuard Cloud account ID.

Query parameters

topinteger

Specifies the number of objects to retrieve (there is a maximum supported by the server).

skipinteger

Bypasses the specified number of objects in the results returned.

countboolean

Indicates whether to return a counter that shows the total number of objects in the total_items response parameter.

filterstring
Example:Retrieves missing patches of the Operating System type: 26018%20Eq%201

Specifies a filter to retrieve patches. You can combine two or more values with the boolean operators %20And%20 and %20Or%20.

  • 26018%20Eq%20{patchTypeEnum} where {patchTypeEnum} => 0=Non-operating system patch,1=Operating system patch
  • 4001%20Eq%20%22{HostName}%22 where {HostName} => Name of the host
  • 26004%20Contains%20%22{ProgramName}%22 where {ProgramName} => Name of the program
  • 26006%20Contains%20%22{PatchName}%22 where {PatchName} => Name of the patch
  • 26003%20Eq%20{CriticalityEnum} where {CriticalityEnum} => 101=Other patches (non-security-related), 201=Critical, 202=Important, 203=Moderate, 204=Low, 205=Unspecified, 301=Service Pack
  • 26008%20Eq%20{CVE} where {CVE} => Common Vulnerabilities and Exposures code assigned to the patch

Response

OK

total_itemsinteger nullable

Total number of retrieved patches.

Example response

{
  "data": {
    "account_id": "cd6c6dd6-b97f-453d-ad81-a5976dc0596c",
    "site_id": "8b7205bc-60e0-45a0-9956-b17b6a8673f6",
    "site_name": "AD360",
    "device_id": "287324d8-194f-4f5a-a7ad-e2480d5ad1b2",
    "host_name": "WIN_SERVER_6",
    "device_type": 2,
    "custom_group_folder_id": "1b7205bc-60e0-45a0-9956-b17b6a8673f6",
    "patch_id": "337324d8-194f-4f5a-a7ad-e2480d5ad1b4",
    "patch_name": "Windows 10",
    "program_name": "Windows 10",
    "program_version": "10.1.1",
    "patch_release_date": "2023-05-15T12:00:00Z",
    "is_downloadable": true,
    "automatic_reboot": true,
    "download_url": "https://download.microsoft.com/download/1/6/D/16DB3B7D-57D0-4E1A-BF24-22BBC4EDBC6A/WSUS-KB2938066-amd64.exe",
    "local_filename": "WSUS-KB2938066-amd64.exe",
    "vendor_name": "Microsoft",
    "family_name": "Windows"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.