device report api · datapoint description agentstatus...

Device Report APIThe Device Report API supports requesting, querying, and reporting on the device inventory data categories,which includes hardware, device platforms, and features that your organization has purchased.

For more information about using Absolute APIs, seeWorking with Absolute APIs.

reporting/devices

The /v2/reporting/devices RESTful resource returns a list of device records and their corresponding data for alldevices in your account or that meet your filtering criteria. Each object in the list is a device record with itsattributes.

Request method and URI

GET /v2/reporting/devices

This endpoint returns the inventory data for all devices in your account, based on your authorization token.

Header Notes Description

Host Required The domain name of the server where the request is sent

Content-Type

Required The media type of the resource

X-Abs-Date Required The automatically generated header that indicates the time (in UTC) the request was madeencoded in a special header

Formatted as: <YYYY><MM><DD>T<HH><MM><SS>Z

Authorization Required The HTTP authorization header

<algorithm> Credential=<token id>/CredentialScope, SignedHeaders=SignedHeaders,Signature=signature

OData query options

The following table describes applicable Open Data Protocol (OData) system query options that can be used aspart of the request.

Option Data type Description

$filter l strings (enclosed insingle quotation marks)

l numbersl boolean valuesl datetime

Identifies all the devices that are managed by your account that meetthe specified criteria.

For example, to view a list of all devices with an Active status(agentStatus eq A):

GET/v2/reporting/devices?$filter=agentStatus%20eq%20’A’

$orderby string Sorts the resulting list according to the properties that you provide.

For example, to search by Identifier in ascending order (Identifierasc):

GET /v2/reporting/devices?$orderby=Identifier%20asc

https://help.absolute.com/corporate/html5/en-us/Content/PDFs/EN/abt-api-working-with-absolute.pdf

Option Data type Description

$select string(as a comma-separated list ofselection clauses)

Returns only those fields listed in the query for all devices that aremanaged by your account.

For example, to return only the manufacturer, model, and serialnumber attributes of your devices:

GET /v2/reporting/devices?$select=systemManufacturer,systemModel,serial

$skip integer Excludes the number of specified results from the search. Use withthe $top option to paginate the data in batches.

For example, to paginate the data in batches of 20:

GET /v2/reporting/devices?$skip=20

$top integer Returns the first <n> elements from the search, where <n> is aninteger that is equal to zero or greater.

For example, to limit the number of records returned to the first 10:

GET /v2/reporting/devices?$top=10

Example

GET https://api.absolute.com/v2/reporting/devices?$filter=esn%20eq%202DE05RUEG0AA1V7S0003

Host:api.absolute.com

Content-Type:application/json

X-Abs-Date:20171122T161351Z

Authorization:ABS1-HMAC-SHA-256 Credential=b62182d4-f3b6-410f-8d1b-

2f14bb66645f/20171122/cadc/abs1, SignedHeaders=host;content-type;x-abs-date,

Signature=751dcdbf34b987de043dc2b9bfb2c9cb2fd34a549e41666122c939953555fabb

Response header

Example

HTTP/1.1 200 OK

Content-Type: text/html

Response body

The API returns an inventory of the Device Report entities in a string. Each device has an array of data points.

Data point Description

id The ID assigned by the manufacturer.

esn The unique Electronic Serial Number (ESN) that is assigned to the agent installed onthe device.

accountUid The unique ID associated with this Absolute account.

firstCallUtc The date and time when the agent initially connected to the Absolute MonitoringCenter, expressed in UNIX Epoch time.

lastUpdatedUtc The date and time when a device’s hardware information was last updated in thedatabase, expressed in UNIX Epoch time.

Device Report API 2

Response header


agentStatus The status of the agent on the device. Available values are:

l A: activel D: disabledl I: inactive

platformOSType The operating system of the device.

fullSystemName The full name assigned to the device.

systemName The name assigned to the device.

systemManufacturer The manufacturer of the device.

systemModel The product name from the manufacturer.

systemType The system running on the Windows-based computer; for example, X64-based PC.

serial The identification number that is assigned to the device by the device manufacturer.

systemDirectory The directory of the operating system.

bootDevice The name of the disk drive from which the Windows operating system starts.

locale The language identifier used by the operating system.

A language identifier is a standard international numeric abbreviation for a country orregion. Each language has a unique language identifier (LANGID), which is a 16-bitvalue that consists of a primary language identifier and a secondary languageidentifier.

username The person logged in on the device at the time of the agent call.

timeZone The time zone represented when daylight savings time is in effect; for example, EDTis Eastern Daylight Savings time.

totalPhysicalRamBytes The total size of the physical memory (in bytes).

availablePhysicalRamBytes The amount of physical memory currently unused and available (in bytes).

totalVirtualMemoryBytes The total amount of virtual memory (in bytes).

For example, you may calculate this total by adding the amount of total RAM to theamount of paging space.

availableVirtualMemoryBytes The amount of unused virtual memory (in bytes).

pageFile The name of the page file.

pageFileSpaceBytes The actual amount of disk space allocated for use with this page file.

domain The name of the Windows domain to which this device belongs.

bios

id The unique identifier of this BIOS given by the manufacturer.

releaseDate The Windows BIOS release date, expressed in UNIX Epoch time.

language The name of the BIOS language.

serialNumber The assigned serial number of the software element.

version The version of the BIOS, as reported by SMBIOS.

versionDate The manufacturer of this software element+The version of the BIOS version, as reported by SMBIOS+The release date of the Window BIOS, in <dd/mm/yyyy> format.

Device Report API 3

Response body


smBiosVersion The version number of the BIOS, as reported by SMBIOS.

smBiosMajorVersion The major version number of the BIOS, as reported by SMBIOS.

smBiosMinorVersion The minor version number of the BIOS, as reported by SMBIOS.

manufacturer The manufacturer of the BIOS.

cdRom

id The unique identifier of the CD-ROM drive.

name The name of the CD-ROM drive.

drive The drive letter of the CD-ROM drive.

mediaType The type of media used or accessed by this device.

description The description of the CD-ROM drive.

status The current status of the object. Available values are::

l Errorl OKl Degraded

transferRate The transfer rate of the CD-ROM drive. A value of -1 indicates that the rate cannot bedetermined which means there is no media in the drive.

pnpDeviceId The Windows Plug and Play device identifier of the logical device.

mediaLoaded Whether media is in the drive. Available values are:

l true: There is media in the drive.l false: There is no media in the drive.

manufacturer The manufacturer of the Windows CD-ROM drive.

scsiTargetId The SCSI identifier number of the Windows CD-ROM drive.

cpu

id The unique identifier of the processor of the system.

name The label by which the object is known.

architecture The processor architecture used by the platform. Some available values are:

l 0: x86l 1: MIPS

dataWidth The width of the data bus; for example, on a 32-bit processor the value is 32, and on a64-bit processor, the value is 64.

logicalCores The number of physical cores multiplied by the number of threads that can run oneach core.

physicalCores The number of cores for the current instance of the processor.

processorSpeed The current speed of the processor, in MHz.

l2CacheSize The size of the Level 2 processor cache.

l3CacheSpeed The clock speed of the Level 3 processor cache.

l3CacheSize The size of the Level 3 processor cache.

disks

id The unique identifier of the disk drive with other devices on the system.

name The name of the disk drive.

Device Report API 4

Response body


bytesPerSector The number of bytes in each sector of the physical disk drive.

description A description of the disk drive.

diskIndex The physical drive number of the given disk drive.

firmwareRevision The revision of the disk drive firmware that is assigned by the manufacturer.

manufacturer The name of the manufacturer of the disk drive.

mediaType The type of media used or accessed by this device. Possible values are:

l External hard disk medial Removable media other than floppyl Fixed hard disk medial Format is unknown

model The model number of the disk drive from the manufacturer.

numberOfPartitions The number of partitions on this physical disk drive that are recognized by theoperating system.

sectorsPerTrack The number of sectors in each track for this physical disk drive.

sizeBytes The size of the disk drive, calculated by multiplying the total number of cylinders,tracks in each cylinder, sectors in each track, and bytes in each sector.

disks.status The current status of the disks. Possible values are:

l OKl Errorl Degradedl Unknownl Pred Faill Startingl Stoppingl Servicel Stressedl NonRecoverl No Contactl Lost Comm

totalCylinders The total number of cylinders on the physical disk drive.

totalHeads The total number of heads on the disk drive.

totalSectors The total number of sectors on the physical disk drive.

totalTracks The total number of tracks on the physical disk drive.

totalTracksPerCylinder The total number of tracks in each cylinder on the physical disk drive.

displays

id The unique identifier of the desktop monitor.

name The name of the monitor.

adapterDescription The description of the monitor.

driverVersion The version number of the driver for the display.

manufacturer The name of the manufacturer of the monitor.

pnpDeviceId The Windows Plug and Play device identifier of the monitor.

Device Report API 5

Response body


keyboards

id The unique address of identifying information that identifies the keyboard.

name The name of the keyboard.

description The description of the keyboard.

layout The layout of the keyboard indicated by a free-form string.

pnpDeviceId The Windows Plug and Play device identifier of the keyboard.

numberOfFunctionKeys The number of function keys on the keyboard.

memories

id The unique identifier of the physical memory device that is represented by aninstance of Win32_PhysicalMemory.

sizeBytes The total capacity of the physical memory, in bytes.

slot The type of memory slot detected on the device.

typeDetail The type of physical memory represented.

networkAdapters

id The unique identifier of the network adapter.

name The name of the network adapter.

adapterType The network medium in use.

defaultGateway An array of IP addresses for the default gateways that the computer system uses.

dhcpEnabled When true, the DHCP server automatically assigns an IP address to the computersystem when establishing a network connection.

dhcpLeaseExpires The expiration date and time for a leased IP address that was assigned to thecomputer by the DHCP server.

dhcpLeaseObtained The date and time the lease was obtained for the IP address assigned to thecomputer by the DHCP server.

dhcpServer The IP address of the DHCP server.

ipV4Address An array of all of the IPv4 addresses associated with the current network adapter.

ipV6Address An array of all of the IPv6 addresses associated with the current network adapter.

ipSubnet An array of all of the subnet masks associated with the current network adapter.

macAddress The media access control (MAC) address for this network adapter.

manufacturer The name of the manufacturer of the network adapter.

productType The type of network adapter product according to the manufacturer.

speed An estimate of the current bandwidth, in bits per second.

installed When true, the network adapter is installed on the system.

serviceName The short name of the product from the manufacturer.

dnsHostName The host name used to identify the device (the default Microsoft networking computername).

interfaceIndex The Index value that identifies the local network interface. Represents the networkinterface in the route table.

pnpDeviceId The Windows Plug and Play device identifier of the logical device.

Device Report API 6

Response body


os

architecture The architecture of the operating system.

build The build number of the operating system.

csdVersion The NULL-terminated string that indicates the latest service pack installed on acomputer. If no service pack is installed, the string is NULL.

installDate The date that the operating system was installed, expressed in UNIX Epoch time.

lastBootTime The date and time that the operating system was last restarted, expressed in UNIXEpoch time.

manufacturer The name of the manufacturer of the operating system.

name The short description of the operating system expressed as a one-line string thatincludes the version of the operating system.

productKey The product key of the operating system.

serialNumber The serial identification number of the operating system.

version The version of the operating system.

windowsDirectory The Windows directory of the operating system.

servicePack The latest service pack installed. If no service pack is installed, the string is NULL.

ubr The subversion number of the operating system.

currentBuild The current build number of the operating system.

releaseId The release number of the operating system.

editionId The edition of the operating system.

printers

id The unique identifier of the printer.

name The name of the printer.

driver The name of the Windows printer driver.

port The port that is used to transmit data to the printer. If a printer is connected to morethan one port, the name of each port is separated by a comma.

volumes

id The unique identifier of the volume on this system.

name The name of the volume.

boot If true, the volume contains the currently running OS files.

compressed How the volume is compressed. Values are:

l true: The volume exists as one compressed entity, such as a DoubleSpacevolume.

l false: File-based compression is supported, such as the NTFS file system

driveLetter The drive letter assigned to the volume.

fileSystem The file system for the volume.

freeSpaceBytes Space available on the logical disk, in bytes.

serial The serial number of the volume.

sizeBytes The size of the volume, in bytes.

Device Report API 7

Response body


usb

id The unique identifier of the USB controller.

name The name of the USB controller.

pnpDeviceId The identifier of the plug and play device.

manufacturer The manufacturer of the USB controller.

agentVersion The version number of the Absolute Agent for the operating system.

ctesVersion The version number of the Absolute Enhanced Agent.

deviceGroupIds The identifier of the device group to which the device belongs.

policyGroupUid The identifier of the policy group, which is a collection of devices to which a set ofpolicies are applied.

policyGroupName The name of the policy group to which the device belongs.

src How the device was created in the system. Available values are:

l agent calll extractl transforml etl: loadl upld: upload

origin The Absolute interface field that identifies the source of the field source

l classic extractl transforml etl: loadl upld: uploaded from the device

lastConnectedUTC The date this device last connected to the monitoring center, expressed in UNIXEpoch time.

hdcStatus (hardware data collection)

status The status of the agent on the device.

statusCode An integer that maps to the status.

featureType The acronym for software data collection.

lastDataReceived The date of the last time the device communicated with the monitoring center,expressed in UNIX Epoch time.

lastUpdated The date of the last time the data was updated, expressed in UNIX Epoch time.

calcStatus Status of the software collection on the device.

enabled If true, this policy is enabled.

dlpStatus

featureType Identifies the Endpoint Data Discovery (EDD) policy. For example, DLP.

calcStatus The status of the EDD policy on the device. For example, INACTIVE.

enabled Indicates whether or not the Endpoint Data Discovery feature is turned on. Availablevalues are:

l true: EDD is turned on.l false: EDD is not turned on.

Device Report API 8

Response body


dfActionStatus:

statuses:OnDemand:

passcode The default passcode used to unfreeze a frozen device sooner than waiting until thedevice’s next agent call.

updatedUTC Date and time when the change in status occurred, expressed in UNIX Epoch time.

score The score of the Device Freeze status, which is a sum of weights for each type ofstatus. This score is used to sort the report in the Device Freeze status column.

A value of zero (0) indicates that the device does not have outstanding device freezerequests against it, and therefore, is not frozen.

The sum is taken from these statuses:

l FreezeRequested = 15l Frozen=300l FreezeScheduled = 10l FreezeConditionSet = 5l FrozenOnSchedule = 200l FrozenByCondition = 100

isStolen Indicates whether this device was reported as stolen.

isCTESActive Indicates whether the device is CTES-enabled. Used to check eligibility of the devicefor actions that require CTES; for example, Absolute Reach (run script, script library).

localIp Last known local IP address of this device.

publicIp Last known public IP address of this device.

publicIpAddress Decimal version of the public IP address.

localIpAddress Decimal version of the local IP address.

The following table describes the available data points for each device in the request.

Data points collected for Windows devices

The following table describes the available inventory of data that you can retrieve for eachmanagedWindowsdevice.


Basic information

deviceUid The unique GUID identifier of the device.


Identifier The unique Electronic Serial Number (ESN) that is assigned to the agentinstalled on the device.esn

platformOSType The operating system type of this device.

lastUpdatedUtc The date and time when a device’s hardware information was last updated inthe database, expressed in UNIX Epoch time.

persistentAgentVersion The build number of Persistence on the device.

System information

fullSystemName The full name assigned to the device.

Device Report API 9






systemType The system running on the Windows-based computer; for example, X64-based PC.

serial The identification number that is assigned to the device by the devicemanufacturer.

systemDirectory The directory of the operating system.

bootDevice The name of the disk drive from which the Windows operating system starts.


A language identifier is a standard international numeric abbreviation for acountry or region. Each language has a unique language identifier (LANGID),which is a 16-bit value that consists of a primary language identifier and asecondary language identifier.


currentUsername The source of this field only accepts non-null and non-empty values.

timeZone The time zone represented when daylight savings time is in effect; forexample, EDT is Eastern Daylight Savings time.




For example, you may calculate this total by adding the amount of total RAMto the amount of paging space.


pageFile The name of the page file.

pageFileSpaceBytes The actual amount of disk space allocated for use with this page file.

Battery (nested collection)

battery.id The identifier of the battery.

battery.name The name of the battery.

battery.serialNumber The unique number given by the manufacturer to identify the battery.

battery.capacity The capacity of the battery in milliwatt hours. If the property is not supported,enter 0 (zero).

battery.estimatedChargeRemaining The estimated percentage of the full charge that remains.

battery.expectedLife The total expected life of the fully charged battery (in minutes).

battery.maxRechargeTime The maximum time to fully charge the battery (in minutes).

Device Report API 10



Bios (nested collection)

bios.releaseDate The Windows BIOS release date, expressed in Coordinated Universal Time(UTC).

bios.language The name of the BIOS language.

bios.serialNumber The assigned serial number of the software element.

bios.version The version of the BIOS, as reported by SMBIOS.

bios.versionDate The manufacturer of this software element+The version of the BIOS version, as reported by SMBIOS+The release date of the Window BIOS, in <dd/mm/yyyy> format.

bios.smBiosVersion The version number of the BIOS, as reported by SMBIOS.

bios.smBiosMajorVersion The major version number of the BIOS.

bios.smBiosMinorVersion The minor version number of the BIOS.

bios.manufacturer The manufacturer of the BIOS.

bios.assetTag The Asset Tag of the device. Was the Detected Asset Number in DDS 5.

CPU (nested collection)

cpu.id The unique identifier of the processor of the system.

cpu.name The label by which the object is known.

cpu.architecture The processor architecture used by the platform. Some available values are:

l 0: x86l 1: MIPS

cpu.dataWidth The width of the data bus; for example, on a 32-bit processor the value is 32,and on a 64-bit processor, the value is 64.

cpu.physicalCores The number of cores for the current instance of the processor.

cpu.processorSpeed The current speed of the processor, in MHz.

cpu.l2CacheSpeed The clock speed of the Level 2 processor cache.

cpu.l2CacheSize The size of the Level 2 processor cache.

cpu.l3CacheSpeed The clock speed of the Level 3 processor cache.


Operating System

os.architecture The architecture of the operating system.

os.build The build number of the operating system.

os.csdVersion The NULL-terminated string that indicates the latest service pack installed ona computer. If no service pack is installed, the string is NULL.

os.installDate The date that the operating system was installed.

os.lastBootTime The date and time the operating system was last restarted.

os.manufacturer The name of the manufacturer of the operating system.

os.name The short description of the operating system expressed as a one-line stringthat includes the version of the operating system.

os.productKey The product key of the operating system.

os.serialNumber The serial identification number of the operating system.




os.version The version of the operating system.

os.windowsDirectory The Windows directory of the operating system.

CD ROM (nested collection)

cdRoms.id The unique identifier of the CD-ROM drive.

cdRoms.name The name of the CD-ROM drive.

cdRoms.drive The drive letter of the CD-ROM drive.

cdRoms.mediaType The type of media used or accessed by this device.

cdRoms.desc The description of the CD-ROM drive.

cdRoms.mediaLoaded Whether media is in the drive. Available values are:

l true: There is media in the drive.l false: There is no media in the drive.

cdRoms.status The current status of the object. Available values are::

l Errorl OKl Degraded

cdRoms.transferRate The transfer rate of the CD-ROM drive. A value of -1 indicates that the ratecannot be determined which means there is no media in the drive.

cdRoms.scsiTargetId The SCSI identifier number of the Windows CD-ROM drive.

cdRoms.pnpDeviceId The Windows Plug and Play device identifier of the logical device.

Disk (nested collection)

disks.id The unique identifier of the disk drive with other devices on the system.

disks.name The name of the disk drive.

disks.bytesPerSector The number of bytes in each sector of the physical disk drive.

disks.description A description of the disk drive.

disks.diskIndex The physical drive number of the given disk drive.

disks.firmwareRevision The revision of the disk drive firmware that is assigned by the manufacturer.

disks.manufacturer The name of the manufacturer of the disk drive.

disks.mediaType The type of media used or accessed by this device. Possible values are:

l External hard disk medial Removable media other than floppyl Fixed hard disk medial Format is unknown

disks.model The model number of the disk drive from the manufacturer.

disks.numberOfPartitions The number of partitions on this physical disk drive that are recognized by theoperating system.

disks.sectorsPerTrack The number of sectors in each track for this physical disk drive.

disks.serialNumber The number allocated by the manufacturer to identify the physical media.

disks.sizeBytes The size of the disk drive, calculated by multiplying the total number ofcylinders, tracks in each cylinder, sectors in each track, and bytes in eachsector.




disks.status The current status of the disks: Possible values are:

l OKl Errorl Degradedl Unknownl Pred Faill Startingl Stoppingl Servicel Stressedl NonRecoverl No Contactl Lost Comm

disks.totalCylinders The total number of cylinders on the physical disk drive.

disks.totalHeads The total number of heads on the disk drive.

disks.totalSectors The total number of sectors on the physical disk drive.

disks.totalTracks The total number of tracks on the physical disk drive.

disks.totalTracksPerCylinder The total number of tracks in each cylinder on the physical disk drive.

Display (nested collection)

displays.id The unique identifier of the desktop monitor.

displays.name The name of the monitor.

displays.manufacturer The name of the manufacturer of the monitor.

displays.adapterDescription The description of the monitor.

displays.adapterRAM The memory size of the video adapter.

displays.bitPerPixel The number of bits used to show each pixel.

displays.height The logical height of the display in screen coordinates.

displays.width The logical width of the display in screen coordinates.

displays.numberOfColors The number of colors that are supported at the current resolution.

displays.refreshRate The frequency at which the video controller refreshes the image for themonitor.

displays.horizontalResolution The current number of horizontal pixels.

displays.verticalResolution The current number of vertical pixels.

displays.pnpDeviceId The Windows Plug and Play device identifier of the monitor.

Keyboard (nested collection)

keyboards.id The unique address of identifying information that identifies the keyboard.

keyboards.name The name of the keyboard.

keyboards.description The description of the keyboard.

keyboards.layout The layout of the keyboard indicated by a free-form string.

keyboards.pnpDeviceId The Windows Plug and Play device identifier of the keyboard.

keyboards.numberOfFunctionKeys The number of function keys on the keyboard.




Memory (nested collection)

memories.id The unique identifier of the physical memory device that is represented by aninstance of Win32_PhysicalMemory.

memories.manufacturer The name of the manufacturer that produced the memory.

memories.serialNumber The number assigned by the manufacturer to identify the memory.

memories.sizeBytes The total capacity of the physical memory, in bytes.

memories.typeDetail The type of physical memory represented.

Network Adapter (nested collection)

networkAdapters.id The unique identifier of the network adapter.

networkAdapters.name The name of the network adapter.

networkAdapters.manufacturer The name of the manufacturer of the network adapter.

networkAdapters.adapterType The network medium in use.

networkAdapters.macAddress The media access control (MAC) address for this network adapter.

networkAdapters.speed An estimate of the current bandwidth, in bits per second.

networkAdapters.defaultGateway An array of IP addresses for the default gateways that the computer systemuses.

networkAdapters.dhcpEnabled When true, the DHCP server automatically assigns an IP address to thecomputer system when establishing a network connection.

networkAdapters.dhcpLeaseExpires The expiration date and time for a leased IP address that was assigned to thecomputer by the DHCP server.

networkAdapters.dhcpLeaseObtained The date and time the lease was obtained for the IP address assigned to thecomputer by the DHCP server.

networkAdapters.dhcpServer The IP address of the DHCP server.

networkAdapters.ipV4Address An array of all of the IPv4 addresses associated with the current networkadapter.

networkAdapters.ipV6Address An array of all of the IPv6 addresses associated with the current networkadapter.

networkAdapters.ipSubnet An array of all of the subnet masks associated with the current networkadapter.

networkAdapters.installed When True, the network adapter is installed on the system.

Pointing device (nested collection)

pointingDevices.id The unique identifier of the pointing device.

pointingDevices.name The description of the pointing device.

pointingDevices.manufacturer The name of the manufacturer of the pointing device.

Printer (nested collection)

printers.id The unique identifier of the printer.

printers.name The name of the printer.

printers.driver The name of the Windows printer driver.

printers.server The name of the server that controls the printer. If this string is NULL, theprinter is controlled locally.

printers.share The name of the share of the printer.




printers.port The port that is used to transmit data to the printer. If a printer is connected tomore than one port, the name of each port is separated by a comma.

Sound (nested collection)

sounds.id The unique identifier of the sound device.

sounds.name The product name of the sound device.

sounds.manufacturer The manufacturer of the sound device.

USB (nested collection)

usb.id The unique identifier of the USB controller.

usb.name The name of the USB controller.

usb.manufacturer The manufacturer of the USB controller.

Volume (nested collection)

volumes.id The unique identifier of the volume on this system.

volumes.name The name of the volume.

volumes.compressed How the volume is compressed. Values are:

l true: The volume exists as one compressed entity, such as aDoubleSpace volume.

l false: File-based compression is supported, such as the NTFS filesystem

volumes.driveLetter The drive letter assigned to the volume.

volumes.fileSystem The file system for the volume.

volumes.serial The serial number of the volume.

volumes.sizeBytes The size of the volume, in bytes.

volumes.freeSpaceBytes Space available on the logical disk, in bytes.

Policy Group

pgid The identifier of the policy group to which this device belongs.

pgnm The name of the policy group to which this device belongs.

Data points collected for Mac devices

The following table describes the available inventory of data that you can retrieve for eachmanagedMac device.


Basic information

deviceUid The unique GUID identifier of the device.


Identifier The unique Electronic Serial Number (ESN) that is assigned to the agentinstalled on the device.esn


System information







systemType The system running on the Mac-based computer.

systemDirectory The system directory of the operating system.

bootDevice The name of the disk drive from which the current Mac operating system starts.


A language identifier is a standard international numeric abbreviation for acountry or region. Each language has a unique language identifier (LANGID),which is a 16-bit value that consists of a primary language identifier and asecondary language identifier.


timeZone The time zone represented when daylight savings time is in effect; for example,EDT is Eastern Daylight Savings time.



For example, you may calculate this total by adding the amount of total RAM tothe amount of paging space.




battery.name The name of the battery.

battery.serialNumber The unique number given by the manufacturer to identify the battery.

battery.capacity The percentage of the battery power level (0-100) that is available.

battery.estimatedChargeRemaining The estimated number of minutes to drain the entire battery.

Camera device (nested collection)

cameras.id The identifier of the camera.

cameras.name The name of the camera.

cameras.model The model of the camera.

cameras.isEnabled Indicates whether the camera is enabled. Available values are Yes and No.


description The name of the device.

cpu.architecture The processor architecture used by the platform. Some available values are:

l 7: x86/i386l 12: ARMl 14: Sparc

cpu.busSpeed The rate at which the processor bus of the computer can transmit data.

cpu.instructionSet The width of the data bus; for example, on a 32-bit processor the value is 32,and on a 64-bit processor, the value is 64.

cpu.logicalCores The number of physical cores multiplied by the number of threads that can runon each core.

cpu.physicalCores The number of cores for the current instance of the processor.







disks.name The name of the disk drive.

disks.removable Indicates whether the disk is removable. Available values are:

l 1: removablel 0: non-removable

disks.serialNumber The identification number that is assigned to the disk by the devicemanufacturer.


displays.manufacturer The name of the manufacturer of the monitor.

displays.adapterDescription The description of the monitor.

displays.depth The number of bits used to show each pixel.

displays.height The logical height of the display in screen coordinates.

displays.width The logical width of the display in screen coordinates.

displays.refreshRate The frequency at which the video controller refreshes the image for the monitor.

Keyboard (nested collection)

keyboards.name The name of the keyboard.

Memory (nested collection)

memories.id The unique identifier of the physical memory.

memories.manufacturer The manufacturer that produced the memory.

memories.serialNumber The number assigned by the manufacturer to identify the memory.

memories.sizeBytes The total capacity of the physical memory, in bytes.

memories.slot The slot locator of the physical memory.

memories.speed The processing speed of the memory in MT/s.

memories.partNumber The part number of the physical memory.

memories.typeDetail The type of physical memory.

memories.status The status of the memory.


networkAdapters.adapterName The name of the network adapter.

networkAdapters.manufacturer The name of the manufacturer of the network adapter.

networkAdapters.macAddress The media access control (MAC) address for this network adapter.

networkAdapters.networkSpeed An estimate of the current bandwidth, in bits per second.

networkAdapters.ssid The Service Set Identifier (SSID) of the Wi-Fi adapter.

Operating System (nested collection)


os.edition The version number of the operating system.


os.lastBootTime The date and time the operating system was last restarted.

Pointing device (nested collection)

pointingDevices.description The description of the pointing device.

pointingDevices.manufacturer The name of the manufacturer of the pointing device.




Printer (nested collection)

printers.name The name of the printer.

printers.driver The name of the printer driver.

Sound (nested collection)

sounds.name The product name of the sound device.

sounds.manufacturer The manufacturer of the sound device.

Volume (nested collection)

volumes.name The name of the volume.

volumes.serialNumber The serial number of the volume.

Data points collected for Android devices

The following table describes the available inventory of data that you can retrieve for eachmanaged Androiddevice.


Basic information

deviceUid The unique identifier of the device.


Identifier The unique Electronic Serial Number (ESN) that is assigned to theagent installed on the device.


System information

systemName The name of the system.

systemManufacturer The manufacturer of the system.

systemModel The model name from the manufacturer.

serial The identification number that is assigned by the manufacturer.

systemDirectory The location of the system files.

locale The region that uses a specific language or unit.

systemType The system running on the Windows-based computer; for example,X64-based PC.


timeZone The time zone of the device.

totalPhysicalRamBytes The total amount of main memory mounted on the device.

availablePhysicalRamBytes The amount of memory that is available for use.


battery.id The identifier of the battery.

battery.capacity The capacity of the battery in milliampere hour (mAh).

battery.estimatedChargeRemaining The amount of time to achieve a fully charged status (in minutes).

battery.expectedLife The expected life expectancy of the battery (in days).

battery.maxRechargeTime The number of times the battery can be charged.





cpu.id The identification number of the device.

cpu.name The model name of the device.

cpu.physicalCores The number of physical cores in the device.

cpu.processorSpeed The speed of each processor.


disks.serialNumber The unique identifier of the disk.


displays.resolution The two-dimensional size (width and height) of the display.

displays.depth The number of bits used to show each pixel.


networkAdapters.adapterType The type of network adapter.

networkAdapters.macAddress The address of the media access control (MAC) card.

networkAdapters.Speed The speed of the network adapter, in megabits per second.

networkAdapters.ipV4Address The current IPv4 address assigned to the network adapter.

networkAdapters.networkSSID The Service Set Identifier (SSID) of the connected Wi-Fi adapter.

Cellular modem (nested collection)

cellularModems.id The identification number of the cellular modem.

cellularModems.radioType The type of radio.

cellularModems.phoneNumber The phone number of the modem.

cellularModems.homeNetworkNumericCode The numeric code of the home network.

cellularModems.homeNetworkName The name of the home network.

cellularModems.currentNetworkNumericCode The numeric code of the current network.

cellularModems.currentNetworkName The name of the network to which the device currently belongs.

cellularModems.simSerial The serial number of the subscriber Identity Module (SIM) card.

cellularModems.imsi The International Mobile Subscriber Identity (IMSI).

This unique identifier is stored on the phone’s SIM card, which isused to identify the user or subscriber of a cellular network. Thenumber includes the country and mobile network to which thesubscriber belongs.

cellularModems.imei The International Mobile Equipment Identity (IMEI), which is a uniqueidentifier assigned to the cellular modem on the device.

cellularModems.enabled Indicates whether the cellular modem is enabled. Available valuesare Yes and No.

cellularModems.type The type of cellular modem.

Bluetooth adapter (nested collection)

bluetoothAdapters.address The address of the Bluetooth adapter.

bluetoothAdapters.enabled Indicates whether the Bluetooth adapter is enabled. Available valuesare Yes and No.




Operating System (nested collection)

os.architecture The architecture of the operating system.



os.lastBootTime The date and time(UTC) that the operating system was last restarted.

os.manufacturer The name of the manufacturer of the operating system.

os.name The name of the operating system.

os.version The version of the operating system.

Camera device (nested collection)

cameras.id The identifier of the camera on the phone.

cameras.description The description of the camera on the phone.

cameras.isEnabled Indicates whether the camera is enabled. Available values are Yesand No.

Example of response model

The following example is a request for a successful Device Report API call on a single device with the identifier(esn) of 2DE05RUEG0AA1V7S0003.

Request

GET https://api.absolute.com/v2/reporting/devices?$filter=esn%20eq%202DE05RUEG0AA1V7S0003

Host:api.absolute.com

Content-Type:application/json

X-Abs-Date:20171122T161351Z

Authorization:ABS1-HMAC-SHA-256 Credential=b62182d4-f3b6-410f-8d1b-

2f14bb66645f/20171122/cadc/abs1, SignedHeaders=host;content-type;x-abs-date,

Signature=751dcdbf34b987de043dc2b9bfb2c9cb2fd34a549e41666122c939953555fabb

NOTE The example has been formatted for clarity. A response is returned as one string.

Response

[

{

"id": "02b9daa4-8e60-4640-8b15-76d41ecf6a94",

"esn": "2DE05RUEG0AA1V7S0003",

"accountUid": "b2f4e2d8-16d9-4ad5-b41b-8663af8d2122",

"lastUpdatedUtc": 1508441448459,

"agentStatus": "A",

"platformOSType": "Windows",

"fullSystemName": "VMUSER.WORKGROUP",

"systemName": "VMUSER",

"systemManufacturer": "VMware, Inc.",

"systemModel": "VMware Virtual Platform",

"systemType": "x64-based PC",



"serial": "VMWARE 56 4D 84 6C 7B 96 F6 EA D3 4A BF BE 81 A4 1",

"systemDirectory": "C:\\Windows\\system32",

"bootDevice": "\\Device\\HarddiskVolume1",

"locale": "English (United States)",

"username": "Vmuser\\QA",

"timeZone": "Pacific Daylight Time",

"totalPhysicalRamBytes": 2147008512,

"availablePhysicalRamBytes": 1652957184,

"totalVirtualMemoryBytes": 4294017024,

"availableVirtualMemoryBytes": 3802251264,

"pageFile": "C:\\pagefile.sys",

"pageFileSpaceBytes": 2146435072,

"domain": "WORKGROUP",

"bios": {

"id": "INTEL - 6040000 ",

"releaseDate": 1459789200000,

"language": "enUS",

"serialNumber": "VMware-56 4d 84 6c 7b 96 f6 ea-d3 4a bf be 81 a4 19 5a",

"version": "INTEL - 6040000 ",

"versionDate": "Phoenix Technologies LTD 6.00, 04/04/2016",

"cpu":{"id":"1",

"smBiosVersion": "2.7",

"smBiosMajorVersion": 2,

"smBiosMinorVersion": 7,

"manufacturer": "Phoenix Technologies LTD"

},

"cdRoms": [

{

"id": "IDE\\CDROMNECVMWAR_VMWARE_IDE_CDR10_______________1.00____

\\5&290FD3AB&0&1.0.0",

"name": "NECVMWar VMware IDE CDR10 ATA Device",

"drive": "D:",

"mediaType": "DVD-ROM",

"description": "CD-ROM Drive",

"status": "OK",

"transferRate": -1.0,

"pnpDeviceId": "IDE\\CDROMNECVMWAR_VMWARE_IDE_CDR10_______________1.00____

\\5&290FD3AB&0&1.0.0",

"mediaLoaded": false,

"manufacturer": "(Standard CD-ROM drives)",

"scsiTargetId": 0

}

],

"cpu": {

"id": "CPU0",

"name": "Intel(R) Xeon(R) CPU X5650 @ 2.67GHz",

"architecture": "9",



"dataWidth": 64,

"logicalCores": 1,

"physicalCores": 1,

"processorSpeed": 2660,

"l2CacheSize": 0,

"l3CacheSpeed": 0,

"l3CacheSize": 0

}

"disks": [

{

"id": "\\\\.\\PHYSICALDRIVE0",

"name": "\\\\.\\PHYSICALDRIVE0",

"bytesPerSector": 512,

"description": "Disk drive",

"diskIndex": 0,

"firmwareRevision": "2.0 ",

"manufacturer": "(Standard disk drives)",

"mediaType": "Fixed hard disk media",

"model": "VMware Virtual disk SCSI Disk Device",

"numberOfPartitions": 2,

"sectorsPerTrack": 63,

"sizeBytes": 34356994560,

"status": "OK",

"totalCylinders": 4177,

"totalHeads": 255,

"totalSectors": 67103505,

"totalTracks": 1065135,

"totalTracksPerCylinder": 255

}

],

"displays": [

{

"id": "DesktopMonitor1",

"name": "Generic Non-PnP Monitor",

"adapterDescription": "Standard VGA Graphics Adapter",

"driverVersion": "6.1.7600.16385",

"manufacturer": "(Standard monitor types)",

"pnpDeviceId": "DISPLAY\\DEFAULT_

MONITOR\\4&31BE19FA&0&12345678&00&0F"

}

],

"keyboards": [

{

"id": "ACPI\\PNP0303\\4&25EE97C0&0",

"name": "Enhanced (101- or 102-key)",

"description": "Standard PS/2 Keyboard",

"layout": "00000409",



"pnpDeviceId": "ACPI\\PNP0303\\4&25EE97C0&0",

"numberOfFunctionKeys": 12

}

],

"memories": [

{

"id": "Physical Memory 0",

"sizeBytes": 2147483648,

"slot": "RAM slot #0",

"typeDetail": 512

}

],

"networkAdapters": [

{

"id": "0",

"name": "WAN Miniport (SSTP)",

"dhcpEnabled": false,

"manufacturer": "Microsoft",

"productType": "WAN Miniport (SSTP)",

"installed": true,

"serviceName": "RasSstp",

"interfaceIndex": 2,

"pnpDeviceId": "ROOT\\MS_SSTPMINIPORT\\0000"

},

{

"id": "1",

"name": "WAN Miniport (L2TP)",



"productType": "WAN Miniport (L2TP)",

"installed": true,

"serviceName": "Rasl2tp",


"pnpDeviceId": "ROOT\\MS_L2TPMINIPORT\\0000"

},

{

"id": "2",

"name": "WAN Miniport (PPTP)",



"productType": "WAN Miniport (PPTP)",

"installed": true,

"serviceName": "PptpMiniport",


"pnpDeviceId": "ROOT\\MS_PPTPMINIPORT\\0000"

},

{



"id": "3",

"name": "WAN Miniport (PPPOE)",



"productType": "WAN Miniport (PPPOE)",

"installed": true,

"serviceName": "RasPppoe",


"pnpDeviceId": "ROOT\\MS_PPPOEMINIPORT\\0000"

},

{

"id": "4",

"name": "WAN Miniport (IPv6)",



"productType": "WAN Miniport (IPv6)",

"installed": true,

"serviceName": "NdisWan",


"pnpDeviceId": "ROOT\\MS_NDISWANIPV6\\0000"

},

{

"id": "5",

"name": "Intel(R) PRO/1000 MT Network Connection",

"adapterType": "Ethernet 802.3",

"defaultGateway": "172.16.1.5",

"dhcpEnabled": true,

"dhcpLeaseExpires": 1509103300000,

"dhcpLeaseObtained": 1508412100000,

"dhcpServer": "172.16.2.10",

"ipV4Address": "172.16.23.40",

"ipV6Address": " fe80::dd30:1930:b5b:238a",

"ipSubnet": "255.255.0.0, 64",

"macAddress": "00:0C:29:A4:19:5A",

"manufacturer": "Intel",

"productType": "Intel(R) PRO/1000 MT Network Connection",

"speed": 1000000000,

"installed": true,

"serviceName": "E1G60",

"dnsHostName": "Vmuser",


"pnpDeviceId": "PCI\\VEN_8086&DEV_100F&SUBSYS_075015AD&REV_

01\\4&B70F118&0&0088"

},

],

"os": {

"architecture": "64-bit",



"build": "7601",

"csdVersion": "Service Pack 1",

"installDate": 1504643335000,

"lastBootTime": 1508412080000,

"manufacturer": "Microsoft Corporation",

"name": "Microsoft Windows 7 Home Premium ",

"productKey": "HQH2G-3TQYV-34QGV-948TJ-B8J99",

"serialNumber": "00359-231-5176261-86148",

"version": "6.1.7601",

"windowsDirectory": "C:\\Windows",

"servicePack": "Service Pack 1"

},

"printers": [

{

"id": "Microsoft XPS Document Writer",

"name": "Microsoft XPS Document Writer",

"driver": "Microsoft XPS Document Writer",

"port": "XPSPort:"

},

{

"id": "Fax",

"name": "Fax",

"driver": "Microsoft Shared Fax Driver",

"port": "SHRFAX:"

}

],

"volumes": [

{

"id": "\\\\?\\Volume{8092a551-92a9-11e7-b7ab-806e6f6e6963}\\",

"name": "\\\\?\\Volume{8092a551-92a9-11e7-b7ab-806e6f6e6963}\\",

"boot": false,

"compressed": false,

"fileSystem": "NTFS",

"freeSpaceBytes": 492269568,

"serial": "2855269274",

"sizeBytes": 524283904

},

{


"name": "C:\\",

"boot": true,


"driveLetter": "C:",

"fileSystem": "NTFS",

"freeSpaceBytes": 9973051392,

"serial": "2318449585",

"sizeBytes": 33833349120



},

{


"name": "D:\\",

"boot": false,


"driveLetter": "D:"

}

],

"usbs": [

{

"id": "PCI\\VEN_15AD&DEV_0770&SUBSYS_077015AD&REV_

00\\4&B70F118&0&1888",

"name": "Standard Enhanced PCI to USB Host Controller",

"pnpDeviceId": "PCI\\VEN_15AD&DEV_0770&SUBSYS_077015AD&REV_

00\\4&B70F118&0&1888",

"manufacturer": "(Standard USB Host Controller)"

},

{

"id": "PCI\\VEN_15AD&DEV_0774&SUBSYS_197615AD&REV_

00\\4&B70F118&0&1088",

"name": "Standard Universal PCI to USB Host Controller",

"pnpDeviceId": "PCI\\VEN_15AD&DEV_0774&SUBSYS_197615AD&REV_

00\\4&B70F118&0&1088",

"manufacturer": "(Standard USB Host Controller)"

}

],

"persistentAgentVersion": "890",

"agentVersion": "8.0.972.0",

"ctesVersion": "1.0.0.2028",

"deviceGroupIds": [

"00000000-0002-4cf6-1000-0000000010f4"

],

"policyGroupUid": "78bfe7f0-da30-4868-8ffe-108d693bdae2",

"policyGroupName": "Device Freeze Policy",

"src": "upld",

"origin": "etl",

"lastConnectedUtc": 1508448645190,

"hdcStatus": {

"status": "OK",

"statusCode": 0,

"featureType": "HDC",

"lastDataReceived": 1508441448459,

"lastUpdated": 1508445940457,

"calcStatus": "OK",

"enabled": true

},



"sdcStatus": {

"status": "OK",

"statusCode": 0,

"featureType": "SDC",

"lastDataReceived": 1505939399974,

"lastUpdated": 1508445940457,

"calcStatus": "OK",

"enabled": true

},

"dlpStatus": {

"featureType": "DLP",

"calcStatus": "INACTIVE",

"enabled": false

},

"dfActionStatus": {

"statuses": {

"OnDemand": {

"passcode": "1234",

"updatedUTC": 1508445384597

}

},

"score": 0

},

"isStolen": false,

"isCTESActive": true,

"localIp": "172.16.23.40",

"publicIp": "172.16.154.103",

"publicIpAddress": 2886769255,

"localIpAddress": 2886735656

}

]

Errors

The following table lists the possible status codes andmessages that may be returned when using this API.

Status code Message Action

401 Unauthorized The Authentication failed. Verify that the correct Token ID and Secret keywere used in the authentication.

404 Not Found Could not find the device report. Verify that the identifier of the device is correct.

500 Server Error An internal server error occurred. If the error persists, contact Absolute TechnicalSupport: www.absolute.com/en/support.


Errors

https://www.absolute.com/en/support

Copyright Information

Device Report API - Document version 1.3

© 2019 - 2020 Absolute Software Corporation. All rights reserved. Reproduction or transmission in whole or in part, in any form, or byanymeans (electronic, mechanical, or otherwise) is prohibited without the prior written consent of the copyright owner. ABSOLUTE, theABSOLUTE logo, and PERSISTENCEare registered trademarksof Absolute Software Corporation. Other namesor logosmentionedhereinmaybe the trademarksof Absolute or their respective owners.


Errors

device report api · datapoint description agentstatus...

Documents