Skip to content

Properties

idstring
required·

The unique identifier for the device

agent_installedboolean

Whether a management agent is installed

agent_versionstring

The management agent version

approval_statusstring

Approval state if the provider requires approval

Possible values:
approvedpendingrejectedunknown
asset_tagstring

The asset tag / inventory tag of the device

backup_last_failure_atstring · date-time

The date and time the last backup failed

backup_last_success_atstring · date-time

The date and time the last backup succeeded

backup_total_bytesnumber

Total backup usage in bytes

created_atstring · date-time

The date and time the device record was created

critical_vuln_countinteger

The number of critical severity vulnerabilities detected on the device

custom_fieldsobject

Provider or customer specific fields mapped into a flexible key-value object

disk_encryptionboolean

Whether the disk encryption is enabled on the device

dns_namestring

The DNS name of the device

edr_installedboolean

Whether an endpoint detection and response (EDR) agent is installed or detected on the device

edr_statusstring

The health/status of the EDR agent on the device, when available from the underlying product

Possible values:
healthyunhealthydegradedunknown
enrollment_statusstring

Enrollment state of the device in the provider

Possible values:
enrolledpendingremovedmissingunknown
firewall_enabledboolean

Whether the host firewall is enabled on the device

first_enrolled_atstring · date-time

The date and time the device was first enrolled

high_vuln_countinteger

The number of high severity vulnerabilities detected on the device

hostnamestring

The host/system name of the device

ip_addressesstring[]

The private IP addresses of the device

is_corporate_ownedboolean

Whether the device is corporate-owned (as opposed to personally-owned/BYOD)

is_offlineboolean

Whether the device is currently offline

last_activity_atstring · date-time

The date and time of the last recorded activity for the device

last_enrolled_atstring · date-time

The date and time the device was most recently enrolled

last_scan_atstring · date-time

The date and time the device was last scanned for vulnerabilities or security posture signals, when supported by the underlying product

mac_addressesstring[]

The MAC addresses of the device

maintenance_end_atstring · date-time

The date and time maintenance ends

maintenance_reasonstring

The maintenance reason message

maintenance_start_atstring · date-time

The date and time maintenance starts

maintenance_statusstring

The maintenance status

Possible values:
nonependingactivecompletedunknown
manufacturerstring

The hardware manufacturer of the device

mdm_enabledboolean

Whether MDM management is enabled on the device

modelstring

The hardware model of the device

namestring

The display name of the device

netbios_namestring

The NetBIOS name of the device (Windows)

notesobject[]

Notes attached to the device

idstring
required·

The note's unique identifier

contentstring

The note's content

ownerobject

The note's owner

1 property
idstring

The note's owner's unique identifier

titlestring

The note's title

organizationobject

The organization/account the device belongs to

idstring

The unique identifier for an organization

namestring

The name of the organization

os_buildstring

The operating system build identifier

os_namestring

The operating system name

os_versionstring

The operating system version

os_version_extrastring

Additional operating system version information

ownerobject

The assigned owner of the device

emailsobject[]

The emails of the user

3 properties
emailstring

The email address

is_primaryboolean

Whether the email address is primary

typestring

The type of email address

idstring

The unique identifier for a user

namestring

The name of the user

patch_statusstring

The patch compliance status of the device, based on signals available in the underlying product

Possible values:
up_to_dateupdates_availableunknown
platformstring

The platform family of the device

Possible values:
windowsmacoslinuxiosipadosandroidchromeosunknown
policyobject

The applied policy / blueprint

idstring

The unique identifier for a policy

namestring

The name of the policy

public_ipstring

The public IP address of the device

remote_dataRecord<string, any>

Raw data returned from the remote API call.

serial_numberstring

The serial number of the device

tagsobject[]

The device's tags

idstring

The tag's unique identifier

namestring

The tag's name

typestring

The type/category of the device

Possible values:
workstationservermobiletabletlaptopdesktopvirtual_machineother
updated_atstring · date-time

The date and time the device record was last updated

warranty_end_atstring · date-time

The date and time warranty ends

warranty_fulfillment_atstring · date-time

The manufacturer fulfillment date

warranty_start_atstring · date-time

The date and time warranty starts