---
title: "Retrieve missing patches."
method: GET
path: "/api/v1/accounts/{accountId}/patchavailability"
---

# Retrieve missing patches.

`GET /api/v1/accounts/{accountId}/patchavailability`

## Request

- Base URL: `https://api.usa.cloud.watchguard.com/rest/aether-endpoint-security/aether-mgmt`
- URL: `https://api.usa.cloud.watchguard.com/rest/aether-endpoint-security/aether-mgmt/api/v1/accounts/{accountId}/patchavailability`
- Auth: API key in header `WatchGuard-API-Key` and HTTP bearer
- TypeScript: <https://skmtc.dev/watchguard/apis/aether-endpoint-security-api/docs/api/v1/accounts/:accountId/patchavailability/get.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `accountId` string, required

## Query parameters

- `top` integer
- `skip` integer
- `count` boolean
- `filter` string

## Response `200`

OK

- PatchAvailabilityOutputFindResponse
  - `data` PatchAvailabilityOutput
    - `account_id` string, uuid: Identifier of the account.
    - `site_id` string, uuid: Identifier of the site.
    - `site_name` string: Name of the site the device belongs to.
    - `device_id` string, uuid: Identifier of the device.
    - `host_name` string: Host name of the device.
    - `device_type` 1 | 2 | 3: Type of device. - 1: Workstation - 2: Laptop - 3: Server
    - `platform_id` 1 | 2 | 3: Device platform. - 1: Windows - 2: Linux - 3: macOS
    - `patch_management_status` 0 | 1 | 2 | 3 | 4 | 5 | 6: Patch Management functionality status. - 0: No protection or No information - 1: Enabled - 2: Disabled - 3: Error - 4: Error installing - 5: No license - 6: Not available
    - `custom_group_folder_id` string, uuid: Identifier of the custom group folder assigned.
    - `isolation_state` 0 | 1 | 2 | 3: Isolation state of the device. - 0: Not isolated - 1: Isolated - 2: Applying isolation - 3: Removing isolation
    - `license_status` 0 | 1 | 2 | 3: Status of the license. - 0: Assigned - 1: Not assigned - 2: Manual deallocation - 3: Auto deallocation
    - `patch_id` string, uuid: Identifier of the patch.
    - `patch_name` string: Name of the patch.
    - `program_name` string: Name of the program associated with the patch.
    - `program_version` string: Version of the program associated with the patch.
    - `patch_release_date` string, date-time: Patch release date.
    - `patch_criticality` 101 | 201 | 202 | 203 | 204 | 205 | 301: Patch severity level. - 101: Other patches (non-security-related) - 201: Critical (security-related) - 202: Important (security-related) - 203: Moderate (security-related) - 204: Low (security-related) - 205: Unspecified (security-related) - 301: Service Pack
    - `patch_type` 0 | 1: Patch type. - 0: Non-operating system patch - 1: Operating system patch
    - `is_downloadable` boolean: Indicates whether the patch is downloadable. - True: Patch Management can download the patch automatically - False: You must install the patch manually, either by adding it to a repository or manually installing it on the target device
    - `is_allowed_manual_installation` boolean: Indicates whether manual patch installation is allowed. - True: Patch Management cannot download the patch automatically, but enables you to add it to a repository - False: Patch Management does not enable you to add the patch to a repository. You must install the patch manually on the target device
    - `automatic_reboot` boolean: Indicates whether the patch can perform an automatic reboot.
    - `download_url` string: Manual patch download url (if available).
    - `local_filename` string: Name of the local patch file (if available).
    - `patch_installation_availability` 1 | 2 | 3 | 4: Indicates the patch availability for installation. - 1: Pending installation - 2: Pending installation (you must add the patch manually to the patch repository) - 3: Pending installation (the patch has already been added to the patch repository) - 4: Pending restart to complete installation
    - `patch_cve_ids` string[]
    - `vendor_id` integer, nullable: Numeric identifier of the vendor associated with the patch (if available).
    - `family_id` integer, nullable: Numeric identifier of the program family associated with the patch (if available).
    - `version_id` integer, nullable: Numeric identifier of the program version associated with the patch (if available).
    - `vendor_name` string: Name of the vendor associated with the patch.
    - `family_name` string: Name of the program family associated with the patch.
  - `total_items` integer, nullable: Total number of retrieved patches.

## Other responses

- `400`: BAD REQUEST.
- `403`: ACCESS DENIED.
- `404`: NOT FOUND.
- `405`: METHOD NOT ALLOWED.
- `500`: INTERNAL ERROR.

---

[API](https://skmtc.dev/watchguard/apis/aether-endpoint-security-api.md) - [All operations](https://skmtc.dev/watchguard/apis/aether-endpoint-security-api/llms.txt) - [OpenAPI document](https://skmtc.dev/watchguard/apis/aether-endpoint-security-api/revisions/1376eee70d39?raw)