Help Center/ Data Encryption Workshop/ API Reference/ APIs/ Key Pair Management APIs/ Key Pair Management/ Accessing the page for clearing private keys
Updated on 2025-10-16 GMT+08:00
View PDF
Share

Accessing the page for clearing private keys

Function

This API is used to delete the private key of an SSH key pair.

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

    kps:SSHKeyPair:clearPrivateKey

    Write

    SSHKeyPair *

    -
    • kps:domainKeypairs:clearpk

    -

URI

DELETE /v3/{project_id}/keypairs/{keypair_name}/private-key

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

keypair_name

Yes

String

Key pair name.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. Can be obtained by calling the IAM API for obtaining the user token (the value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

Request succeeded.

Status code: 404

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

404

The requested resource does not exist or is not found.

Error Codes

See Error Codes.

Parent Topic: Key Pair Management