Disable Device¶
Disable a device.
Operation Permissions¶
Required Authorization |
Required Operation Permission |
|---|---|
Device Management |
Full Access |
Request Format¶
POST https://{apigw-address}/connect-service/v2.1/devices?action=disable
Request Parameters (URI)¶
Note
Use one of the following methods to specify the device to be disabled:
Include
assetIdin the requestInclude
productKey+deviceKeyin the request
Name |
Location (Path/Query) |
Mandatory/Optional |
Data Type |
Description |
|---|---|---|---|---|
orgId |
Query |
Mandatory |
String |
The organization ID which the asset belongs to. How to get orgId>> |
assetId |
Query |
Optional (See Note above) |
String |
The asset ID. How to get assetId>> |
productKey |
Query |
Optional (See Note above) |
String |
The product key. To be used with |
deviceKey |
Query |
Optional (See Note above) |
String |
The device key. To be used with |
Error Codes¶
Code |
Message |
Description |
|---|---|---|
99500 |
Device is disabled |
The device has already been disabled. |
Samples¶
Request Sample¶
url: https://{apigw-address}/connect-service/v2.1/devices?action=disable&orgId=yourOrgId&assetId=yourAssetId
method: POST
Return Sample¶
{
"code": 0,
"msg": "OK",
"requestId": "b3f22f9b-d90d-4bf2-9e97-79162a3d1dff",
"data": null
}