Help Center > > API Reference> Northbound API Reference> Device Management> Deleting a Device

Deleting a Device

Updated at: Aug 28, 2019 GMT+08:00

Typical Scenario

If a device that has been registered on the IoT platform does not need to connect to the IoT platform, an NA can call this API to delete the device. If the device needs to connect to the IoT platform again, register it again.

API Function

This API is used by an NA to delete a registered device from the IoT platform.

API Prototype

Method

DELETE

URL

https://server:port/iocm/app/dm/v1.4.0/devices/{deviceId}?appId={appId}&cascade={cascade}

Transport Protocol

HTTPS

Request Parameters

Parameter

Mandatory or Optional

Type

Location

Description

app_key

Mandatory

String

header

Identifies an application that can be accessed on the IoT platform. The value of this parameter is allocated by the IoT platform when the application is created on the platform.

Authorization

Mandatory

String

header

Indicates the authentication information for accessing the IoT platform. The value is Bearer {accessToken}, in which {accessToken} indicates the access token returned by the Authentication API.

deviceId

Mandatory

String

path

Uniquely identifies a device. The value of this parameter is allocated by the IoT platform during device registration.

appId

Optional

String

query

Identifies an application that can be accessed on the IoT platform. The value of this parameter is allocated by the IoT platform when the application is created on the platform. Set this parameter to the value of appId of the authorized application.

cascade

Optional

Boolean

query

This parameter is valid only when the device is connected to indirectly-connected devices. The default value is true.

  • true: The directly connected device and the indirectly-connected devices connected to it are deleted.
  • false: The directly connected device is deleted but the indirectly-connected devices connected to it are not deleted. In addition, the attribute of the indirectly-connected devices is changed to directly-connected.

Response Parameters

Status Code: 204 No Content

Request Example

Method: DELETE
Request:
https://server:port/iocm/app/dm/v1.4.0/devices/{deviceId}?appId={appId}&cascade={cascade}
Header:
app_key: ******
Authorization: Bearer ******

Response Example

Response:
Status Code: 204 No Content

Error Codes

HTTP Status Code

Error Code

Error Description

Remarks

403

100203

The application is not existed.

The application does not exist.

Recommended handling:

  • Check whether appId carried in the HTTP request header is correct.
  • Check whether appId in the request path (URL) is correct.

403

100217

The application hasn't been authorized.

The application has not been authorized.

Recommended handling: In scenarios where applications are not authorized, ensure that request parameter appId is null.

403

1010009

app throttle exceed.

The NA calls the API at a frequency that exceeds the flow control threshold (100 calls per minute by default).

Recommended handling: Contact IoT platform maintenance personnel to adjust the flow control threshold or control the API call frequency.

403

1010005

App_key or access_token is invalid.

The access token is invalid.

Recommended handling: Check whether accessToken carried in the API request is correct.

404

100403

The device is not existed.

The device does not exist.

Recommended handling: Check whether deviceId is correct.

404

100418

The deviceData is not existed.

The device data does not exist.

Recommended handling:

  • If deviceId carried in the request is incorrect, check whether deviceId belongs to appId or whether deviceId is incorrect.
  • Check whether appId carried in the header contains deviceId.
  • If the URL contains the optional parameter appId, check whether the value of appId is correct.

500

100203

The application is not existed.

The application does not exist.

Recommended handling:

  • Check whether appId carried in the HTTP request header is correct.
  • Check whether appId in the request path (URL) is correct.

500

50252

Internal server error.

An internal server error occurs.

Recommended handling: An internal error occurs on the IoT platform. Contact IoT platform maintenance personnel.

Did you find this page helpful?

Submit successfully!

Thank you for your feedback. Your feedback helps make our documentation better.

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?







Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel