Updated on 2026-09-21 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

Definition

Project ID. For details, see Obtaining a Project ID.

Constraints

N/A

Range

The value returned by the IAM API is used, which contains 32 characters.

Default Value

N/A

keypair_name

Yes

String

Definition

Key pair name

Constraints

Key pair name. The value can contain at most 255 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

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.

Constraints

N/A

Range

Obtain the value by calling the IAM API for obtaining the user token.

Default Value

N/A

Response Parameters

Status code: 204

OK

None

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

204

OK

Error Codes

See Error Codes.