Update SSH key pair description

This API is used to update SSH key pair description.

PUT /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.

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
keypair	Yes	UpdateKeypairDescriptionReq object	Message body for updating the SSH key pair description.

**Table 4** UpdateKeypairDescriptionReq
Parameter	Mandatory	Type	Description
description	Yes	String	Description.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

{
  "keypair" : {
    "description" : "description"
  }
}

Status code: 400

Error occurred.

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

Status Code	Description
200	OK.
400	Error occurred.

Parent topic: Key Pair Management

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.