Change History

2026-09-02

This issue is the twenty-eighth official release.

Newly added:

• Confirm the Execution of a Batch Task
• Create a Generic-Protocol Configuration
• Query the Generic-Protocol Configuration List
• Delete a Generic-Protocol Configuration
• Query Details About a Generic-Protocol Configuration
• Update Generic-Protocol Configurations

2025-11-30

This issue is the twenty-seventh official release.

Newly added:

• Add Domain Configurations
• Obtain the Domain Configuration List
• Delete Domain Configurations
• Query Domain Configurations
• Update Domain Configurations
• Create an OTA Module
• Query the OTA Module List
• Query OTA Module Details
• Delete an OTA Module
• Modify an OTA Module
• Add a Server Certificate
• Obtain the Server Certificate List
• Delete a Server Certificate
• Query the Server Certificate
• Query a CA Certificate

Modified:

Added the MQTT_DEVICE_FORWARDING enumeration type to the channel parameter to support device message forwarding. Involved APIs: Create a Rule Action, Query the Rule Action List, and Query a Rule Action.

2025-09-09

This issue is the twenty-sixth official release.

Newly added:

• Querying Instance Specifications
• Querying the Instance Task List
• Query Instance Task Details
• Retry an Instance Task

• Delete Device Shadow
• Query Security Situation Awareness Configurations
• Create a Security Situation Awareness Configuration
• Query the Details About the Security Situation Awareness Configuration of a Specific ID
• Delete the Security Situation Awareness Configuration of a Specific ID
• Update the Security Situation Awareness Configuration Information of a Specific ID
• Create a HarmonyOS Soft Bus
• Query the HarmonyOS Soft Bus List
• Query the HarmonyOS Soft Bus
• Delete a HarmonyOS Soft Bus
• Synchronize the HarmonyOS Soft Bus
• Reset the HarmonyOS Soft Bus Key
• Query Device Certificate List
• Query a Device Certificate
• Update a Device Certificate
• Delete a Device Certificate
• Query the List of Devices that Use a Specified Device Certificate
• Create a Device Authentication Template
• Query the Device Authentication Template List
• Delete a Device Authentication Template
• Modify the Device Authentication Template
• Query Details About an Authentication Template

2025-07-29

This issue is the twenty-fifth official release.

Newly added:

• Delete a Message with a Specified Message ID

2025-02-28

This issue is the twenty-fourth official release.

Newly added:

• Modify a Device Gateway

2024-11-26

This issue is the twenty-third official release.

Newly added:

• Query a Command in the Queue of a Device
• Query a Historical Device Command
• Collects Statistics on the Total Number of Historical Commands of a Device
• Create a Codec Function
• Query a Codec Function
• Delete a Codec Function

2024-09-13

This is the twenty-second official release.

Newly added:

• Create an IoTDA Instance
• This API is used to query the instance list.
• Query Instance Details
• Modify Instance Information
• Delete an Instance
• Modify Instance Specifications
• Change the Billing Mode of an Instance
• Adding an Instance Tag
• Delete an Instance Tag

2024-06-25

This issue is the twenty-first official release, which incorporates the following change:

Newly added:

• Create a Device Policy
• Query the Device Policy List
• Delete a Device Policy
• Query Device Policy Details
• Update Device Policy Information
• Bind a Device Policy
• Unbind a Device Policy
• Query the List of the Targets Bound to a Device Policy
• Create a Pre-provisioning Template
• Query the Pre-provisioning Template List
• Delete a Pre-provisioning Template
• Query Pre-provisioning Template Details
• Update Information About a Pre-provisioning Template with a Specified ID
• Create a Custom Authenticator
• Query the Custom Authenticator List
• Delete a Custom Authenticator
• Query Custom Authenticator Details
• Update a Custom Authenticator with a Specified ID

2024-05-30

This issue is the twentieth official release, which incorporates the following change:

Newly added:

• Create a Bridge
• Query the Bridge List
• Delete a Bridge
• Reset the Bridge Secret
• Update a CA Certificate
• Query the List of Device Groups to Which a Specified Device Is Added

2024-04-26

This issue is the nineteenth official release, which incorporates the following change:

Newly added:

• Create a Device Proxy
• Query Device Proxy List
• Query Device Proxy Details
• Modify a Device Proxy
• Delete a Device Proxy

2024-04-11

This issue is the eighteenth official release, which incorporates the following change:

Newly added:

• Create a Data Transfer Stacking Policy
• Query the Data Transfer Stacking Policy List
• Modify a Data Transfer Stacking Policy
• Query the Data Transfer Stacking Policy
• Delete a Data Transfer Stacking Policy
• Create a Data Forwarding Flow Control Policy
• Query a List of Data Forwarding Flow Control Policies
• Modify a Data Forwarding Flow Control Policy
• Query a Specified Data Forwarding Flow Control Policy
• Delete a Specified Data Forwarding Flow Control Policy

2024-03-29

This issue is the seventeenth official release, which incorporates the following change:

Newly added:

• Update Resource Spaces

Modified:

• Create a Batch Task, Query the Batch Task List, and Query a Batch Task: Added the task_mode parameter (gateway mode for software/firmware upgrade tasks) and the task_ext_info parameter (additional information for batch tasks).

2024-03-13

This issue is the sixteenth official release, which incorporates the following changes:

Modified:

Update a CA Certificate and Obtain the CA Certificate List: Added the provision_enable parameter (whether the self-registration capability is enabled for the CA certificate) and the template_id parameter (ID of the template associated after the self-registration capability is enabled).

2024-02-27

This issue is the fifteenth official release, which incorporates the following changes:

Modified:

Creating a Rule, Query the Rule List, Modify a Rule and Query a Rule: Changed the message_content parameter in the ActionSmnForwarding structure to an optional parameter, adjusted the value range of the message_title parameter, and added the message_template_name parameter to provide the capability of selecting an SMN template.

2023-01-05

This issue is the fourteenth official release, which incorporates the following changes:

Modified:

• Generate an Access Credential: Added the force_disconnect parameter to specify whether to forcibly disconnect the northbound MQTT/AMQP connection when an access credential is generated.

2023-12-06

This issue is the thirteenth official release, which incorporates the following changes:

Modified:

• Added the secret_type parameter to set or update a sub secret of the device. Involved API: Resetting a Device Secret.
• Added the fingerprint_type parameter to set or update a sub fingerprint of the device. Involved API: Resetting a Device Fingerprint.
• Added response parameters secondary_secret and secondary_fingerprint to query a sub fingerprint or sub secret of a device. Involved APIs: Querying a Device, Creating a Device, and Modifying a Device.

2023-11-15

This issue is the twelfth official release, which incorporates the following changes:

Modified the Create a Rule Action, Query a Rule Action, Query the Rule Action List, and Modify a Rule Action APIs.

• Modified the enumerated values of the mechanism parameter in the dms_kafka_forwarding structure, and added the security_protocol parameter to support complete Kafka security authentication.
• Added the signature_enable and token parameters to the http_forwarding structure to provide diversified security authentication capabilities for HTTP push.

2023-10-23

This issue is the eleventh official release, which incorporates the following changes:

Modified:

Query the Product List: Added the product_name input parameter to support search by product name.

2023-07-21

This issue is the tenth official release, which incorporates the following changes:

Newly added:

• Delete a Batch Task
• Create a Device Tunnel
• Query All Tunnels of a Device
• Query Device Tunnels
• Disable a Device Tunnel
• Delete a Device Tunnel

2023-06-17

This issue is the ninth official release, which incorporates the following changes:

Newly added:

• Re-Execute a Batch Task
• Stop a Batch Task

Modified:

Synchronous Device Command and Modify Device Properties: Added the response parameters error_code and error_msg to return abnormal device behaviors during synchronization, such as no response due to timeout.

2023-05-13

This issue is the eighth official release, which incorporates the following changes:

Modified:

Create a Device Group, Modify a Device Group, Query the Device Group List and Query a Device Group: Added the group_type and dynamic_group_rule parameters to support dynamic device groups.

2023-04-19

This issue is the seventh official release, which incorporates the following changes:

Newly added:

Broadcasting a Message

Modified:

Create a Batch Task, Query the Batch Task List, and Query a Batch Task: Modified the task_type parameter and added the enumerated value updateDevices to support batch update of device tasks.

2023-03-29

This issue is the sixth official release, which incorporates the following changes:

Modified:

Creating a Rule, Modify a Rule, Query the Rule List and Query a Rule: Added the device_linkage_status_condition parameter to define the linkage rule conditions for device status changes.

2023-02-24

This issue is the fifth official release, which incorporates the following changes:

Newly added:

• Create an OTA Upgrade Package
• Query the OTA Upgrade Package List
• Obtain OTA Upgrade Package Details
• Delete an OTA Upgrade Package

Modified:

Query a Device: Added the response parameters connection_status_update_time and active_time to query the connection status change time and activation time of a device.

2023-02-07

This issue is the fourth official release, which incorporates the following changes:

Modified:

Create a Rule Action, Query a Rule Action, Query the Rule Action List, and Modify a Rule Action: Added the dms_rocketmq_forwarding, mrs_kafka_forwarding, roma_forwarding, and influxdb_forwarding parameters to support message forwarding for RocketMQ, kafka, ROMA, and InfluxDB.

2022-12-14

This issue is the third official release, which incorporates the following changes:

Newly added:

Query Device List Flexibly

Modified:

Creating a Rule, Modify a Rule, Query the Rule List, and Query a Rule: Added the enumerated value DEVICE_SIDE for the rule_type parameter to support rule linkage on devices.

2022-09-20

This issue is the second official release, which incorporates the following changes:

Deliver a Message to a Device and Query Device Messages: Added the properties parameter to support MQTT 5.0.

2022-06-30

This is the first official release.

API Reference on the Application Side

MQTT or MQTTS API Reference on the Device Side

HTTPS API Reference on the Device Side

Module AT Command Reference