Help Center/ IoT Device Access/ API Reference/ API Reference on the Application Side/ API/ Device Certificate/ Update a Device Certificate
Updated on 2026-09-30 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Update a Device Certificate

Function

This API is used by an application to update the status of a device certificate on the IoT platform.

Calling Method

For details, see Calling APIs.

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:devicecertificates:update

    Write

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    -

    -

URI

PUT /v5/iot/{project_id}/device-certificates/{certificate_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

certificate_id

Yes

String

Parameter description: a unique ID that identifies a device certificate. The ID is allocated by the platform when the device certificate is registered.

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.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

status

Yes

String

Parameter description: device certificate status.

  • ACTIVE (default)

  • INACTIVE

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

certificate_id

String

Parameter description: a unique ID that identifies a device certificate.

common_name

String

Parameter description: common name of the device certificate.

expiry_date

String

Parameter description: expiration time of the device certificate.

fingerprint

String

Parameter description: SHA-256 fingerprint of the device certificate.

status

String

Parameter description: device certificate status.

  • ACTIVE (default)

  • INACTIVE

certificate_pem

String

Parameter description: content of the device certificate in PEM format.

Example Requests

Update a Device Certificate

PUT https://{endpoint}/v5/iot/{project_id}/device-certificates/{certificate_id}

{
  "status" : "ACTIVE"
}

Example Responses

Status code: 200

{
  "certificate_id" : "75a0c144-7c3c-4dac-9fd6-8c63dd9e969d",
  "common_name" : "iot_device",
  "expiry_date" : "20230810T070547Z",
  "fingerprint" : "4838A6CCBC582DC22647005FBDFB2B110632DDDA5FCFB55B3307C122EFC2D1BA",
  "status" : "ACTIVE",
  "certificate_pem" : "-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----"
}

Status Codes

Status Code

Description

200

OK

404

Not Found

Error Codes

See Error Codes.

Parent topic: Device Certificate