Help Center/ IoT Device Access/ API Reference (Ally Region)/ API Reference on the Application Side/ API/ Device Shadow/ Delete Device Shadow
Updated on 2026-06-29 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Delete Device Shadow

Function

This API is used by an application to delete the device shadow of a specific device, including the desired device properties (in the desired section) and the latest properties reported by the device (in the reported section).

URI

DELETE /v5/iot/{project_id}/devices/{device_id}/shadow

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Parameter description : project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

device_id

Yes

String

Parameter description: a unique ID that identifies a device. The value of this parameter is specified during device registration or allocated by the platform.

Value: The value can contain a maximum of 128 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Instance-Id

No

String

Parameter description : instance ID. Unique identifier of each instance in the physical multi-tenant scenario. Mandatory for professional editions and recommended in other cases. Log in to the IoTDA console and choose Overview in the navigation pane to view the instance ID. For details, see Viewing Instance Details.

Response Parameters

Status code: 204

No Content

None

Example Requests

Deletes the device shadow of a specified device.

DELETE https://{endpoint}/v5/iot/{project_id}/devices/{device_id}/shadow

Example Responses

None

Status Codes

Status Code

Description

204

No Content

400

Bad Request

401

Unauthorized

403

FORBIDDEN

404

Not Found

500

INTERNAL SERVER ERROR

Error Codes

See Error Codes.

Parent topic: Device Shadow