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 assetId in the request
Include productKey + deviceKey in 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`.
deviceKey	Query	Optional (See Note above)	String	The device key. To be used with `productKey`.

Error Codes¶

Code	Description
11794	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
}

Java SDK Sample¶

package com.envisioniot.enos.api.sample.connect_service.device;

import com.envision.apim.poseidon.config.PConfig;
import com.envision.apim.poseidon.core.Poseidon;
import com.envisioniot.enos.connect_service.v2_1.device.DisableDeviceRequest;
import com.envisioniot.enos.connect_service.v2_1.device.DisableDeviceResponse;


public class DisableDevice {
    public static void main(String[] args) {
        final String appKey = "yourAppKey";
        final String appSecret = "yourAppSecret";
        String serverUrl = "yourServerUrl";

        String orgId = "yourOrgId";
        String assetId = "yourAssetId";
        DisableDeviceRequest request = new DisableDeviceRequest();
        request.setOrgId(orgId);
        request.setAssetId(assetId);
        DisableDeviceResponse response = Poseidon.config(PConfig.init().appKey(appKey).appSecret(appSecret).debug())
                .url(serverUrl)
                .getResponse(request, DisableDeviceResponse.class);

    }
}