Updated on 2026-06-29 GMT+08:00

Reset the HarmonyOS Soft Bus Key

Function

This API is used by an application to reset the HarmonyOS soft bus key. After the reset, the status changes to unsynchronized. You need to call the synchronization API to synchronize the latest key to devices in the group.

URI

POST /v5/iot/{project_id}/harmony-soft-bus/{bus_id}/reset-bus-key

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Parameter description : project ID. For details, see Obtaining a Project ID.

bus_id

Yes

String

Parameter description: Unique ID of a HarmonyOS soft bus, which is allocated by the IoT platform when the soft bus is created.

Value: The value can contain a maximum of 36 characters, including hexadecimal strings and hyphens (-).

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Instance-Id

No

String

Parameter description: instance ID. This parameter is required only when the API is called from the management plane in the physical multi-tenant scenario. Log in to the IoTDA console and choose Overview in the navigation pane to check the instance ID.

Response Parameters

Status code: 200

OK

None

Example Requests

POST https://{endpoint}/v5/iot/{project_id}/harmony-soft-bus/{bus_id}/reset-bus-key

Example Responses

None

Status Codes

Status Code

Description

200

OK

404

Not Found

Error Codes

See Error Codes.