Get Remediation Link v2.2

API version	2.2
Last Update	05/28/2015
Authentication	YES
Response Format	JSON
HTTP Method	GET
Rate limited	YES
Requests per rate limit	10/min

Use to fetch a remediation link for a given device

API URL

https://gears.opswat.com/o/api/v2.2/devices/:value/remediation

Request Parameters

Key	Datatype	Parameter Type	Required	Description	Default
access_token	string	URL	Yes	access token which archived from OAuth authentication step
value	string	URL	Yes	HWID or MAC address of the device
opt	sint	URL	Optional	Type of the given value in the URL. 1 - the given value is HWID. 0 - the given value is MAC Address	0

Key

Datatype

Parameter Type

Required

Description

Default

access_token

string

URL

Yes

access token which archived from OAuth authentication step

value

string

URL

Yes

HWID or MAC address of the device

opt

sint

URL

Optional

Type of the given value in the URL.

1 - the given value is HWID. 0 - the given value is MAC Address

Response HTTP Code

See APIs

Response Parameters

Key	DataType	Description
remediation_link	string	(optional) remediation page URL for the given device.
result	int	(optional) indicate if the request is processed successfully. 0: failure
msg	string	(optional) error details

Key

DataType

Description

remediation_link

string

(optional) remediation page URL for the given device.

result

int

(optional) indicate if the request is processed successfully.

0: failure

msg

string

(optional) error details

Example

Example Request

https://gears.opswat.com/o/api/v2.2/devices/00:0c:29:f2:7a:29/remediation?access_token=TEST7P9ZMJ2LBF8AMOMJLFNPMMLO953AVQ4C9YFF52R61234

Example Response

//if the given device has issues

{

"remediation_link" : "https://gears.opswat.com/gears/remediation/AKLOMFNH123518/00:0c:29:f2:7a:29/123AG138545132156/remediation.html"

}

//if the given device has no issues

{

"result": 0,

"msg": "Device has no issues"

}

//if the given device is not found in the associated account

{

"result": 0,

"msg": "Device not found"

}

History

Version	URL
v2.0	Get Remediation Link 2.0

Last updated on

Was this page helpful?