Public API - Inventory

Inventory API

Resources

/inventory	Returns an array of inventory computers	GET
/inventory/{id}	Returns one computer's inventory by id	GET
/inventory/{computername}	Returns one computer's inventory by computer name	GET
/inventory/{id}	Delete one computer by id	DELETE
/inventory/{computername}	Delete one computer by computer name	DELETE

Note that the prefix of urls above depend on which data center you belong to. Please log in to see the full url.

Headers

apikey

Your apikey listed in your settings to retrieve the data

int

Filters

Filters can be supplied either as URL parameters or headers.

wantsoftware	Use this filter, if you wish to receive lists of installed software. The default is to not return installed software	bit
wantgroups	Use this filter, if you wish to receive user and computer groups. The default is to not return groups	bit
startid	The starting ID you wish to receive. Can be used for incremental offload of data to your own system	int
take	Maximum number of resources to return. Default is 50 to preserve bandwidth, maximum is 10000. For queries with more than 10000 records, pagination is mandatory	int

Example filtered url to get 10 entries: /inventory?wantsoftware=1&take=10
Pagination works by using the last id in the list and feeding it as startid in the next query

Fields

id	The unique ID of this computer. This ID can be used to query updated information on this entry by appending it to the url to request this resource only	int
name	The computer's name	string
inventoryAvailable	Determines if inventory is collected for this computer. Privacy settings may disable inventory collection; see example two for non-inventoried computer	bit
inventoryDate	Date of last inventory refresh	datetime
abrClientVersion	Installed version of the Admin By Request endpoint software	string
abrClientInstallDate	Install date of the Admin By Request endpoint software	datetime
notes	The "Notes" left menu for any notes or comments relating to the this computer	string

user.account	The user account the end user used to log on to the computer	string
user.fullName	The full name of the user user	string
user.email	The user's email address	string
user.phone	The user's phone number	string
user.domain	The user's Active Directory log on domain (if any)	string
user.orgUnit	Name of user's Active Directory Organizational Unit (name of last node in the tree)	string
user.orgUnitPath	The full path to the user's Active Directory Organizational Unit	string
user.isAdmin	Determines if the logged on user is administrator.	bit
user.isDomainJoined	Determines if the logged on user account is an Active Directory account	bit
user.isAzureJoined	Determines if the logged on user account is an Azure AD account	bit
user.groups[]	The Active Directory or Azure AD groups the user is member of	string

owner.account	The owner of the endpoint	string
owner.fullName	The full name of the owner	string

computer.domain	The computer's Active Directory domain (if any)	string
computer.isDomainJoined	Determines if the computer is joined to an Active Directory	bit
computer.isAzureJoined	Determines if the computer is joined to Azure AD	bit
computer.orgUnit	Name of computer's Active Directory Organizational Unit (name of last node in the tree)	string
computer.orgUnitPath	The full path to the computer's Active Directory Organizational Unit	string
computer.groups[]	The Active Directory or Azure AD groups the computer is member of	string
computer.localAdmins[]	List of local administrators	string
computer.users[]	List of user accounts on Mac computers	string

operatingSystem.platform	Operating system platform (possible values: Windows, Mac, Server)	string
operatingSystem.platformCode	0 = Windows, 1 = Mac, 2 = Server,	int
operatingSystem.name	Name of operating system (e.g. Windows 10 Pro)	string
operatingSystem.version	The operating system version	string
operatingSystem.release	The operating system release number	int
operatingSystem.build	The build number for Windows 10 or newer	int
operatingSystem.buildUpdate	The update to the build version on Windows 10 or newer	int
operatingSystem.type	Workstation or Server	string
operatingSystem.typeCode	0 = Workstation, 1 = Server	int
operatingSystem.bits	Operating system bits (32 or 64)	int
operatingSystem.installDate	Operating system install date	datetime

hardware.make	The vendor of the computer	string
hardware.model	The model of the computer	string
hardware.type	Desktop or Portable	string
hardware.typeCode	0 = Portable/Laptop, 1 = Desktop	int
hardware.serviceTag	The service tag (serial number) of the computer	string
hardware.cpu	Name and model of the CPU	string
hardware.cpuSpeed	CPU speed in Mhz	int
hardware.cpuCores	Number of CPU cores	int
hardware.diskSize	The size of the primary disk in GB	int
hardware.diskFree	Free disk space of the primary disk in GB	int
hardware.diskStatus	Current S.M.A.R.T. status of the primary disk	string
hardware.memory	Amount of memory in MB	int
hardware.noMonitors	Number of monitors	int
hardware.monitorResolution	Resolution of the primary monitor	string
hardware.bitlockerEnabled	Bitlocker status, if available	bit
hardware.isCompliant	Is InTune compliant	bit
hardware.tpmEnabled	Trusted Platform Module (TPM) enabled	bit
hardware.tpmVersion	Trusted Platform Module (TPM) version	string

network.publicIP	The public IP address of the fastest active network adapter	string
network.privateIP	The private IP address of the fastest active network adapter	string
network.macAddress	MAC address of the fastest active network adapter	string
network.nicSpeed	Speed (mbit) of the fastest active network adapter	string
network.hostName	The public host name of the fastest active network adapter	string

location.city	The city of the computer location	string
location.region	The region of the computer location	string
location.country	The country of the computer location	string
location.latitude	The latitude of the computer location	string
location.longitude	The longitude of the computer location	string
location.googleMapsLink	The location on Google Maps	string
location.hourOffset	The offset in hours from Coordinated Universal Time (UTC)	int

software[].application	The name of an application (description property of file)	string
software[].vendor	The vendor of the application	string
software[].version	The version of the application	string
software[].installDate	The install date of the application	datetime
software[].size	The size of the application in megabytes	int
software[].bits	The bitness of the application (32 or 64)	int

Example successful request

[
  {
    "id": 49779198,
    "name": "W10405945",
    "inventoryAvailable": true,
    "inventoryDate": "2020-03-27T08:17:11",
    "abrClientVersion": "6.3.0",
    "abrClientInstallDate": "2020-03-27T08:15:32",
    "notes": null,
    "user": {
      "account": "PDH",
      "fullName": "Paul David Hewson",
      "email": "pdh@acme.com",
      "phone": "555.345.6789",
      "domain": "ACME",
      "orgUnit": "Users",
      "orgUnitPath": "\\Users",
      "isAdmin": false,
      "groups": [
        "Domain Users",
        "Users"
      ]
    },
    "owner": {
        "account": "support@fasttracksoftware.com",
        "fullName": "FastTrack Software Support"
    },
    "computer": {
      "domain": "ACME",
      "orgUnit": "Computers",
      "orgUnitPath": "\\Computers",
      "groups": [
        "Domain Computers"
      ],
      "localAdmins": [
        "Administrator",
        "ACME\\Domain Admins"
      ],
      "users": []
    },
    "operatingSystem": {
      "platform": "Windows",
      "platformCode": 0,
      "name": "Windows 10 Pro",
      "version": 1909,
      "build": 18363,
      "buildUpdate": 752,
      "type": "Workstation",
      "typeCode": 0,
      "bits": 64,
      "installDate": "2019-06-19T00:00:00"
    },
    "hardware": {
      "make": "Dell Inc.",
      "model": "XPS 9550",
      "type": "Laptop",
      "typeCode": 0,
      "serviceTag": "4577-7924-6610-3168-2590-1337-74",
      "cpu": "Intel Core i7-3520M CPU @ 2.90GHz",
      "cpuSpeed": 2893,
      "cpuCores": 4,
      "diskSize": 135,
      "diskFree": 84,
      "diskStatus": "OK",
      "bitlockerEnabled": true,
      "memory": 2147,
      "noMonitors": 1,
      "monitorResolution": "1024x768"
    },
    "network": {
      "publicIP": "10.20.30.40",
      "privateIP": "10.10.129.52",
      "macAddress": "AF:4F:E3:23:62:E1",
      "nicSpeed": "1000 mbit",
      "hostName": "internal.acme.dk"
    },
    "location": {
      "city": "San Francisco",
      "region": "California",
      "country": "Unites States",
      "latitude": "37.7576948",
      "longitude": "122.4727052",
      "googleMapsLink": "https://maps.google.com/?q=37.7576948,122.4727052"
    },
    "software": [
      {
        "name": "Admin By Request Workstation",
        "version": "6.3.0.0",
        "vendor": "FastTrack Software",
        "installDate": "2020-03-27T00:00:00"
      },
      {
        "name": "Adobe Acrobat Reader DC",
        "version": "20.006.20042",
        "vendor": "Adobe Systems Incorporated",
        "installDate": "2020-04-01T00:00:00"
      },
      {
        "name": "Microsoft Office 365 ProPlus - en-us",
        "version": "16.0.11929.20648",
        "vendor": "Microsoft Corporation",
        "installDate": null
      },
      {
        "name": "Mozilla Firefox 67.0.1 (x86 en-US)",
        "version": "67.0.1",
        "vendor": "Mozilla",
        "installDate": null
      },
      {
        "name": "OPSWAT Client",
        "version": "7.6.271.0",
        "vendor": "OPSWAT, Inc.",
        "installDate": null
      },
      {
        "name": "Visual Studio Community 2019",
        "version": "16.4.29709.97",
        "vendor": "Microsoft Corporation",
        "installDate": "2020-01-19T00:00:00"
      }
    ]
  }
]

Example without inventory

[
  {
    "name": "W10405945",
    "inventoryAvailable": false,
    "abrClientVersion": "6.3.0",
    "abrClientInstallDate": "2020-03-27T08:15:32",
    "user": null,
    "computer": null,
    "operatingSystem": null,
    "hardware": null,
    "network": null,
    "location": null,
    "software": null
  }
]

Inventory API

Resources

Headers

Filters

Fields

Example successful request

Example without inventory

LATEST CYBERSECURITY BLOGS

Admin Persona 1 of 5: The 'Pop'

Privileged Access Management Just Got Personal

Venus Ransomware Hits Healthcare