Help Center/ IoT Device Access/ API Reference/ API Reference on the Application Side/ API/ OTA module management./ Delete an OTA Module
Updated on 2026-01-29 GMT+08:00
View PDF
Share

Delete an OTA Module

Function

This API is used to delete an OTA module.

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:otamodules:delete

    Write

    app *

    g:EnterpriseProjectId

    -

    -

URI

DELETE /v5/iot/{project_id}/ota-upgrades/modules/{module_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

module_id

Yes

String

Parameter description: ID of the OTA module, which is automatically generated by the platform and used to uniquely identify a module. The value is obtained after the module is created.

Value: The value can contain up to 36 characters. Only letters, digits, 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

This API is used to delete an OTA module.

DELETE https://{endpoint}/v5/iot/{project_id}/ota-upgrades/modules/{module_id}

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: OTA module management.