Help Center/ IoT Device Access/ API Reference/ API Reference on the Application Side/ API/ OTA Upgrade Package Management/ Delete an OTA Upgrade Package
Updated on 2023-11-08 GMT+08:00
View PDF
Share

Delete an OTA Upgrade Package

Function

This API is used to delete the upgrade package information associated with an OBS object. The OBS object will not be deleted. To use this API, grant IoTDA instances the permission to access OBS and the KMS Administrator permissions. On the IAM console, choose Agencies, locate the iotda_admin_trust agency, and grant KMS Administrator and OBS OperateAccess permissions to the agency.

Debugging

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

URI

DELETE /v5/iot/{project_id}/ota-upgrades/packages/{package_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.

package_id

Yes

String

Parameter description: upgrade package ID, which uniquely identifies an upgrade package. The value is allocated by the IoT platform. Value: The value can contain a maximum of 36 characters. Only letters, digits, and hyphens (-) are allowed.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

Parameter description: user token. You can obtain the token by calling the IAM API Obtaining a User Token Through Password Authentication. In the returned response header, X-Subject-Token is the desired user token. For details about how to obtain the token, see Token Authentication.

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. You can log in to the IoTDA console and choose Overview in the navigation pane to view the instance ID.

Response Parameters

None

Example Requests

Deletes an OTA upgrade package.

DELETE https://{endpoint}/v5/iot/{project_id}/ota-upgrades/packages/{package_id}

Example Responses

None

Status Codes

Status Code

Description

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.