Help Center/ IoT Device Access/ API Reference/ API Reference on the Application Side/ API/ Device Tunnel Management/ Delete a Device Tunnel
Updated on 2026-01-29 GMT+08:00
View PDF
Share

Delete a Device Tunnel

Function

You can use this API to delete a device tunnel. After the deletion, the channel does not exist and cannot be connected again.

  • This API is not supported by Basic editions.

  • For details, see [Remote Login] (https://support.huaweicloud.com/intl/en-us/usermanual-iothub/iot_01_00301.html).

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    iotda:tunnel:delete

    Write

    -

    g:EnterpriseProjectId

    -

    -

URI

DELETE /v5/iot/{project_id}/tunnels/{tunnel_id}

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.

tunnel_id

Yes

String

Tunnel ID.

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 a device tunnel.

DELELE https://{endpoint}/v5/iot/{project_id}/tunnels/{tunnel_id}

Example Responses

None

Status Codes

Status Code

Description

204

no content

400

Invalid value.

401

Unauthorized

403

Authentication failed.

404

The tunnel does not exist.

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Device Tunnel Management