Updating SSH Key Pair Description

Function

This API is used to update the description of an SSH key pair.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

• If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
• If you are using identity policy-based authorization, the following identity policy-based permissions are required.

  Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
  kps:SSHKeyPair:update	Write	SSHKeyPair *	-	kps:domainKeypairs:update	-

URI

PUT /v3/{project_id}/keypairs/{keypair_name}

Request Parameters

Response Parameters

Status code: 200

OK

Status code: 400

Example Requests

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

Example Responses

Status code: 400

Error response

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

Status Codes

Error Codes

See Error Codes.