Retrieve installed software.

Retrieves the software installed on the computers on the network.

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

Request

Base URL
https://api.usa.cloud.watchguard.com/rest/aether-endpoint-security/aether-mgmt
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/softwareinventory/get.ts
A function with typed inputs. Its response is checked against the schema.

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 the software installed on a device named 'HostName': 4001%20Eq%20%22HostNameExample%22

Specifies a filter to retrieve the software inventory

4001%20Eq%20%22{HostName}%22 where {HostName} => Name of the device in URL encoded format

Response

total_itemsinteger nullable

Total number of retrieved software programs

Example response

{
  "data": {
    "site_id": "8b7205bc-60e0-45a0-9956-b17b6a8673f6",
    "site_name": "AD360",
    "device_id": "287324d8-194f-4f5a-a7ad-e2480d5ad1b2",
    "host_name": "WIN_SERVER_10",
    "device_type": 2,
    "ip_address": "172.25.1.10",
    "operating_system": "Microsoft Windows 10",
    "custom_group_folder_id": "1b7205bc-60e0-45a0-9956-b17b6a8673f6",
    "name": "Windows 11",
    "publisher": "Microsoft",
    "installation_date": "2023-06-25T12:00:00Z",
    "is_patch": true
  }
}

Changes

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