Devices Action v2.0

API version2.0
Last Update01/12/2015
AuthenticationYES
Response FormatJSON
HTTP MethodPOST
Rate limitedYES
Requests per rate limit10/min

Use to send a remote command to given devices

API URL

Copy

Request Parameters

KeyDatatypeParameter TypeRequiredDescriptionDefault
access_tokenstringURLYesaccess token which archived from OAuth authentication step
optintBodyOptional0 - MAC address
1 - HWID
0
typesstringBodyYesThe action type: dhcprenew - renew ip address for network interfaces on devices. exempt_all - exempt devices. unexempt - unexempt devices.
MAC_listarray<string>BodyOptionalMAC addresses of devices you want to send remote command. \ The request body must have MAC_list parameter or HWID_list parameter, but not both.
HWID_listarray<string>BodyOptionalHWIDs of devices you want to send remote command. _The request body must have MAC_list parameter or HWID_list parameter, but not both._

Response HTTP Code

HTTP CodeDescription
200Success
400Bad request
401Unauthorized. Your access_token is invalid or expired
404Not found

Response Parameters

KeyDataTypeDescription
resultarray<int>

The result of batch action. Result[i] value means that the action on device[i] is

  • 0: failure

  • 1: success

Note: reasons can cause failure

  • the cloud couldn't find any devices which reports the given MAC address or HWID

  • the given MAC address is invalid

Example

Example Request

Copy

Example Response

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