Delete Device v2.0
|
API version |
2.0 |
|
Last Update |
7/17/2014
|
|
Authentication |
YES |
|
Response Format |
JSON |
|
HTTP Method |
POST |
|
Rate limited |
YES |
|
Requests per rate limit |
10/min |
Use to delete a device on a given account
API URL
https://gears.opswat.com/o/api/v2/devices/:value/delete
Request Parameters
|
Key |
Datatype |
Parameter Type |
Required |
Description |
Default |
|
value |
string |
URL |
Yes |
MAC Address or HWID of a device to be deleted |
|
|
access_token |
string |
URL |
Yes |
access token which archived from OAuth authentication step |
|
|
opt |
int |
URL |
Optional |
0 – Only uninstall an agent on the device but keep the device data on Cloud 2 - Archive Cloud database entry for the device and uninstall an agent on the device |
1 |
Response HTTP Code
|
HTTP Code |
Description |
|
200 |
Success |
|
401 |
Unauthorized. Your access_token is invalid or expired |
|
404 |
Not found |
Response Parameters
|
Key |
Datatype |
Description |
|
result |
int |
0 - failure |
|
msg |
string |
Result details |
Example
Request Example
https://gears.opswat.com/o/api/v2.2/devices/0CQN6GRVGU2F1/delete?opt=0&access_token=TEST7P9ZMJ2LBF8AMOMJLFNPMMLO953AVQ4C9YFF52R61234
Response Example
{ "result": 1, "msg": "Device has been deleted"}