Help Center> Data Encryption Workshop> API Reference> APIs> Key Pair Management APIs> Key Pair Management> Update SSH key pair description
View PDF

Update SSH key pair description

Function

This API is used to update SSH key pair description.

URI

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.

Request Parameters

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.

Response Parameters

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

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

Example Responses

Status code: 400

Error occurred.

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

Status Codes

Status Code

Description

200

OK.

400

Error occurred.

Error Codes

See Error Codes.

Parent topic: Key Pair Management