Get Remediation Link

API version3.0
Last Update10/22/2019
AuthenticationYES
Response FormatJSON
HTTP MethodGET
Rate limitedYES
Requests per rate limit10/min

Use to fetch a remediation link for a given device

API URL

Copy

Request Parameters

KeyDatatypeParameter TypeRequiredDescriptionDefault
access_tokenstringURLYesaccess token which archived from OAuth authentication step
valuestringURLYesit can be a device ID or MAC address or a custom ID of a device. It depends on value of the "opt" parameter
optintURLOptionalType of the given value in the URL. 0: Device ID or Mac Address 1: 3rd party custom ID which is linked with a device0

Response HTTP Code

See APIs

Response Parameters

KeyDataTypeDescription
remediation_linkstringremediation page URL for the given device.
resultint

Result for get a remediation page which has the given HWID/MAC address

  • -1: device is found, but the device status is Out of license usage
  • 0: device is not found.
  • 1: device is found, and the device's remediation page URL is returned in the remediation_link parameter

Example

Example Request

Copy

Example Request With opt=0

Copy

Example Response

Copy

Example Request With Invalid opt

Copy

Example Response With Invalid opt

HTTP code 400 Bad Request

Copy

History

Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard