Listing Software

Base URL

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_all_software

Description

Lists software by type for the specified asset.

Parameters

Required parameters

Add required parameters immediately after the base URL.

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_all_software&required_parameters={parameter-value}

Parameter	Description	Type	Options	Default
assetid	The assetid must be a valid asset id. The required assetid is referenced in the list_device_asset_details call.	integer	0	0

Parameter

Description

Type

Options

Default

assetid

The assetid must be a valid asset id.

The required assetid is referenced in the list_device_asset_details call.

integer

Optional parameters

Add optional parameters after the required parameters in the base URL.

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_all_software&required_parameters={parameter-value}&optional_parameters={parameter-value}

Parameter	Description	Type	Options	Default
describe	Optional. Returns a description of the entered call, the available parameters, an example of its output, and returned fields with descriptions.	boolean	true	0

Determine parameter values

Use the following associated service calls to determine parameter values.

Parameter	Call	URL Format
assetid	list_device_asset_details	https://{SERVER}/api/?apikey={yourAPIkey}&service=list_device_asset_details&deviceid=DEVICEID
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

Examples

List software for an asset

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_all_software&assetid=ASSETID

Example response

<?xml version="1.0"?>
<result created="2024-10-01T12:47:15+01:00" host="SERVER" status="OK">
  <items>
    <software>
      <softwareid>5341882</softwareid>
      <catalogid>239</catalogid>
      <name>Security Update for Windows Media Player (KB911564)</name>
      <version />
      <install_date />
    </software>
    <!-- more <software> nodes -->
  </items>
</result>

Returned fields

Field	Type	Can Be Empty	Description
softwareid	integer	no	The unique identifier of the software on this asset
catalogid	integer	no	The unique identifier of the software
name	string	yes	The name of the software
version	string	yes	The version of the software installed on this asset
install_date	datetime	yes	The date and time the software was installed