Device Action v2.0
| API version | 2.0 |
|---|---|
| Last Update | 03/24/2015 |
| Authentication | YES |
| Response Format | JSON |
| HTTP Method | POST |
| Rate limited | YES |
| Requests per rate limit | 10/min |
Use to send a command to a given device
API URL
Request Parameters
| Key | Datatype | Parameter Type | Required | Description | Default |
|---|---|---|---|---|---|
| access_token | string | URL | Yes | access token which archived from OAuth authentication step | |
| types | string | URL | Yes | The action type. dhcprenew - renew ip address for interfaces. exempt_critical - enable exempt critical mode for device. exempt_all - enable exempt all mode for device. unexempt - disable exempt mode for device. | |
| id | string | URL | Yes | HWID or MAC Address of a device to be applied the action. | |
| opt | int | URL | Optional | 0 - MAC Address 1 - HWID | 0 |
Response HTTP Code
| HTTP Code | Description |
|---|---|
| 200 | Success |
| 400 | Bad Request |
| 401 | Unauthorized. Your access_token is invalid or expired |
| 404 | Not found |
Response Parameters
| Key | Datatype | Description |
|---|---|---|
| result | int | 0 - failure 1- success |
| msg | string | Result details |
Example
Request Example
Response Example
Was this page helpful?