Developer Guidelines
10.6.26061
Search this version
Developer Guidelines
Developer Guidelines
Archived APIs
Title
Message
Create new category
What is the title of your new category?
Edit page index title
What is the title of the page index?
Edit category
What is the new title of your category?
Edit link
What is the new title and URL of your link?
Devices Action v2.0
Summarize Page
Copy Markdown
Open in ChatGPT
Open in Claude
| API version | 2.0 |
|---|---|
| Last Update | 01/12/2015 |
| Authentication | YES |
| Response Format | JSON |
| HTTP Method | POST |
| Rate limited | YES |
| Requests per rate limit | 10/min |
Use to send a remote command to given devices
API URL
xxxxxxxxxxhttps://gears.opswat.com/o/api/v2/devices/actionRequest 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 1 - HWID | 0 |
| types | string | Body | Yes | The action type: dhcprenew - renew ip address for network interfaces on devices. exempt_all - exempt devices. unexempt - unexempt devices. | |
| MAC_list | array<string> | Body | Optional | MAC 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_list | array<string> | Body | Optional | HWIDs 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 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 | array<int> | The result of batch action. Result[i] value means that the action on device[i] is
|
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
xxxxxxxxxxhttps://gears.opswat.com/o/api/v2/devices/action?access_token=TEST7P9ZMJ2LBF8AMOMJLFNPMMLO953AVQ4C9YFF52R61234{ "types" : "dhcprenew", "MAC_list" : ["00:0c:29:cd:c7:b2", "00:0c:30:cd:ff:b2"], "opt" : 0}Example Response
xxxxxxxxxx{ "result": [0, 1]}VariableType to search · ESC to discard
GlossaryType to search · ESC to discard
InsertType to search · ESC to discard
No matches
Last updated on
Was this page helpful?
Next to read:
Device Action v3.0null
Discard Changes
Do you want to discard your current changes and overwrite with the template?
Archive Synced Block
Message
Create new Template
What is this template's title?
Delete Template
Message