Get Devices v2.2

API version	2.2
Last Update	01/30/2018
Authentication	YES
Response Format	JSON
HTTP Method	GET
Rate limited	YES
Requests per rate limit	10/min
Changes	Support phone/tablet 01/30/2018: removed agent_type in input parameters. API will ignore agent_type parameter in the input

Use to get all devices on a given account

API URL

Request Parameters

Key	Datatype	Parameter Type	Required	Description	Default
access_token	string	URL	Yes	access token which archived from OAuth authentication step
limit	int	URL	Optional	Specific maximum number of devices will be returned in the response. The value should be in [1,50]. If there are more devices than what the limit asks for, error code will be 406.	1
page	int	URL	Optional	Specific page number which devices will be returned in. If the requested page exceeds the number of pages of devices, error code will be 413. It means that the requested page number is too large, no devices will be returned in this case.	1
GroupBy	string	URL	Optional	Specific how to group devices. Values can be: none - No need to group devices hwid - HWID host - hostname issues - number of issues	none
order	string	URL	Optional	Sort order. Values can be: des - descending. asc - ascending.	des

Response HTTP Code

HTTP Code	Description
200	Success
401	Unauthorized. Your access_token is invalid or expired
406	Too many devices to return
413	Requested page number exceeds limit

Response Parameters

Key	DataType	Description
hwid	string	Hardware ID of the device
agent_type	string	Agent type that runs on the device. (optional)
remediation_link	string	URL of remediation page for the given device
status	int	Reports the compliance status of the endpoint. This status is based on the defined policy within MetaAccess. Status values are: 0 – the endpoint is in compliance with MetaAccess account’s policies 1 – the endpoint is not in compliance with MetaAccess account’s policies 3 – the endpoint is still sending information to MetaAccess and not yet completed
hostname	string	Hostname of the device
nickname	string	nickname for the device (admin editable)
agent_version	string	Local resident MetaAccess agent version
last_seen	string	The last timestamp in GMT format when MetaAccess agent reports its data to Cloud
machine_type	string	The type of devices
country	string	Region where the device IP geographically represents
active	int	1 - device is connected to Cloud, 0 - disconnected
total_issue	int	Number of issues were seen on the device
user	string	Username of a group
user_info	object	User information block
user_info.username	string	Currently logged in username
user_info.domain	string	Currently logged in user domain
os_info	object	Operation system block
os_info.family	string	OS family
os_info.name	string	OS name
os_info.vendor	string	OS vendor
os_info.version	string	OS version
os_info.service_pack_version	string	OS Service Pack Version
os_info.architecture	string	OS architecture
os_info.os_language	string	OS language
os_info.user_password_set	string	If user password is set on OS, 1 is set, 0 is not set
network_info	array<object>	Network adapter information block
network_info.mac_addr	string	MAC address of a network adapter
network_info.ipv4_addr	string	IPV4 address of a network adapter
network_info.ipv6_addr	string	IPV6 address of a network adapter
total_critical_issue	int	Number of critical issues were seen on the device
critical_status	int	This critical status is based on the defined policy within MetaAccess. This status apply for the whole device. Critical status values are: 0 – the endpoint doesn't have critical issues 1 – the endpoint has critical issues 2 – the endpoint is not found
exempt	int	Exempt status of the endpoint device. Exempt values are: 0 – Endpoint device is not exempted 1 – Endpoint device is exempted

Example

Example Request

Example Response

Example Response for Mobile devices

History

Version	URL
v2.1	Get Devices v2.1

Last updated on

Was this page helpful?