Updated on 2025-12-29 GMT+08:00

Clearing a Private Key

Function

Delete the private key of an SSH key pair.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

keypair_name

Yes

String

Key pair name

Request Parameters

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 404

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Request

None

Example Response

None

Status Codes

Status Code

Description

200

Request succeeded.

404

The requested resource does not exist.

Error Codes

For details, see Error Codes.