Devices Policy Check

API version

2.0

Last Update

10/14/2014

Authentication

YES

Response Format

JSON

HTTP Method

POST

Rate limited

YES

Requests per rate limit

10/min

Use to check device status of given devices

API URL

https://gears.opswat.com/o/api/v2/devices/policy_check


Request Parameters

Key

Datatype

Parameter Type

Required

Description

Default

access_token

string

URL

Yes

access token which archived from OAuth authentication step

 

opt

int

Body

Optional

0 - MAC address
(will add more option in future)

0

MAC_list

array<string>

Body

Optional

MAC addresses of devices you want to check status

 

Response HTTP Code

See 1.2. OAuth APIs


Response Parameters

Key

DataType

Description

result

array<int>

Device compliance status based on the defined policy within MetaAccess Management.

Values can be:

  • 0 – the endpoint is in compliance with MetaAccess account’s policies

  • 1 – the endpoint is not in compliance with MetaAccess account’s policies

  • 2 – the endpoint is not found, it could mean endpoint not reporting, or the endpoint does not have the MetaAccess agent installed

  • 3 – the endpoint is still sending information to MetaAccess and not yet completed

critical

array<int>

Device critical status based on the defined policy within MetaAccess.

0 – the endpoint doesn't have critical issues
1 – the endpoint has critical issues
2 – the endpoint is not found


Example

Example Request

https://gears.opswat.com/o/api/v2/devices/policy_check?access_token=TEST7P9ZMJ2LBF8AMOMJLFNPMMLO953AVQ4C9YFF52R61234
Posting data:
{
"opt" : 0,
"MAC_list": [
"00:0c:29:f2:7a:29",
"00:0c:29:f2:7a:30",
"00:0c:29:f2:7a:31"
]
}

Example Response

{
"result": [2,0,1],
"critical": [2,0,0]
}