Help Center/ IoT Device Access/ API Reference/ API Reference on the Application Side/ API/ Device Policy Management/ Delete a Device Policy
Updated on 2024-11-06 GMT+08:00
View PDF
Share

Delete a Device Policy

Function

This API is used by an application to delete a specified policy from the IoT platform. Note that deleting a policy will unbind all objects bound to the policy.

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}/device-policies/{policy_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.

policy_id

Yes

String

Policy ID. Value: A string of 24 characters consisting of letters and digits.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

Parameter description: user token. Obtain the token by calling the IAM API for 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. 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

None

Example Requests

Deletes a device policy with a specified ID.

DELETE https://{endpoint}/v5/iot/{project_id}/device-policies/{policy_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: Device Policy Management