logo

Device

This document describes the API for reading Devices.

List Devices

Returns a list of Devices.

Search parameters

Filter Description
cpu The cpu info available for this Device
created_at The date this Device object was created
device_name The name of the Device
device_user_name The Device user's name
hard_drive_encrypted Flag to indicate if the hard drive is encrypted
id The ID of the Device
in_audit_scope Flag to indicate if this Device is in scope
last_checkin_at The date this Device last checked in
local_firewall_enabled Flag to indicate if the local firewall is enabled
mac_address The MAC address of the Device
make The make of the Device
memory The memory of the Device
model The model of the Device
native_anti_virus_enabled Flag to indicate if native antivirus is enabled
os The operating system of the Device
out_of_audit_scope_reason Out of scope reason if the Device is not in scope
owner_name The Device owner's name
password_enforcement_enabled Flag to indicate if password enforcement is enabled
remote_ip The remote IP of the Device
serial_number The serial number of the Device
session_timeout_enabled Flag to indicate if session timeout is enabled
updated_at The date this Device was last updated
Securityheader_authorization
Request
query Parameters
include
boolean

Set to true along with relationships to return the entire relationship data in the included key within the response.

page
integer

Used for pagination of response data (default: page 1). Specifies the offset of the next block of data to receive.

per_page
integer

Used for pagination of response data (default: 1000 items per response). Specifies the number of results for a given page.

q
string

Search and filter the Device data using Lucene syntax.

relationships
boolean

Set to true to return the associated relationships data within the response. (default: false)

Responses
400

Bad Request

401

Unauthorized

403

Forbidden

default
get/devices
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get a Device
Returns a single Device by ID


Securityheader_authorization 
Request 
path Parameters
id
required
string
Scope response to id


 
Responses 
400
Bad Request


401
Unauthorized


403
Forbidden


404
Resource not found


default
get/devices/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    },
  • "includes": { }
}
➔ Next to Evidence