Help Center/ Bare Metal Server/ API Reference/ BMS APIs/ BMS SSH Key Management (Native OpenStack APIs)/ Deleting an SSH Key Pair (Native OpenStack API)
Updated on 2025-10-16 GMT+08:00
View PDF

Deleting an SSH Key Pair (Native OpenStack API)

Function

This API is used to delete a specified SSH key pair based on the key pair name.

URI

DELETE /v2.1/{project_id}/os-keypairs/{keypair_name}

Table 1 lists the parameters.

Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID.

For details about how to obtain the project ID, see Obtaining a Project ID.

keypair_name

Yes

Specifies the key pair name.

You can obtain the key pair name by calling the Querying SSH Key Pairs (Native OpenStack API) API.

Request Parameters

None

Example Request

Deleting an SSH key pair (name: KeyPair-123) 
1
 
DELETE https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/os-keypairs/keypair-test

Response

N/A

Returned Values

Normal values

Returned Values

Description

204

The server has processed the request but did not return any content.

For details about other returned values, see Status Codes.

Error Codes

See Error Codes.