Search Devices v2.1

API version2.1
Last Update01/30/2018
AuthenticationYES
Response FormatJSON
HTTP MethodGET
Rate limitedYES
Requests per rate limit10/min
Changes01/30/2018: removed agent_type in input parameters. API will ignore agent_type parameter in the input

Use to query devices on a given account

API URL

Copy

Request Parameters

KeyDatatypeParameter TypeRequiredDescriptionDefault
access_tokenstringURLYesaccess token which archived from OAuth authentication step
qstringURLYesSpecific search keywords, as well as any qualifiers. Multi-words are separated by +, for example Tomas Hertus is searched as tomas+hertus.
Minimum of characters is 3. Maximum of characters is 100
instringURLYesQualifies which fields are used for search. The caller of the API is responsible for providing this information.
limitintURLOptionalSpecific 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.
Maximum value is 50		10
pageintURLOptionalSpecific 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

Response HTTP Code

HTTP CodeDescription
200Success
400Bad request
401Unauthorized. Your access_token is invalid or expired
404Not found
406Too many devices to return
413Requested page number exceeds limit

Response Parameters

KeyDataTypeDescription
total_countintNumber of devices which match to search criteria
resultsarray<object>Lists of devices which match to search criteria
results.hwidstringHardware ID of the device
results.remediation_linkstringURL on remediation page for given device
results.statusint

Reports the health status of the endpoint device. This status is based on the defined policy within . 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 and not yet completed

results.hostnamestringHostname of the device
results.nicknamestringnickname for the device (admin editable)
results.agent_versionstringLocal resident MetaAccess agent version
results.last_seenstringThe last timestamp in GMT format when MetaAccess agent reports its data to Cloud
results.machine_typestringThe type of devices
results.countrystringRegion where the device IP geographically represents
results.activeint1 - device is active, 0 - deactive
results.total_issueintNumber of issues were seen on the device
results.userstringUsername of a group
results.user_infoobjectUser information block
results.user_info.usernamestringCurrently logged in username
results.user_info.domainstringCurrently logged in user domain
results.os_infoobjectOperation system block
results.os_info.familystringOS family
results.os_info.namestringOS name
results.os_info.vendorstringOS vendor
results.os_info.versionstringOS version
results.os_info.service_pack_versionstringOS Service Pack Version
results.os_info.architecturestringOS architecture
results.os_info.os_languagestringOS language
results.os_info.user_password_setintIf user password is set on OS, 1 is set, 0 is not set
results.network_infoarray<object>Network adapter information block
results.network_info.mac_addrstringMAC address for adapter
results.network_info.ipv4_addrstringIPV4 address
results.network_info.ipv6_addrstringIPV6 address

Example

Example Request

Copy

Advanced Example Request

Copy

Example Response

Copy
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard
Next to read:
Status Change v2.1
On This Page
Search Devices v2.1API URLRequest ParametersResponse HTTP CodeResponse ParametersExample