Updated on 2025-09-15 GMT+08:00

Deleting an SSH Key Pair

Function

This API is used to delete an SSH key pair.

Calling Method

For details, see Calling APIs.

URI

DELETE /v3/{project_id}/keypairs/{keypair_name}

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: 204

OK

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Example Requests

None

Example Responses

Status code: 400

Error response

{
  "error_code" : "KPS.XXX",
  "error_msg" : "XXX"
}

Status Codes

Status Code

Description

204

OK

400

Error response

Error Codes

See Error Codes.