Skip to main content
PATCH
/
me
/
ssh-keys
/
{sshKeyId}
Update an SSH key.
curl --request PATCH \
  --url https://console.gmicloud.ai/api/v1/me/ssh-keys/{sshKeyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My Updated SSH key"
}
'
{
  "group": "ssh-key",
  "code": 501,
  "message": "The user has no permission to access the SSH key."
}

Authorizations

​
Authorization
string
header
required

An access token used to authenticate a user and grant access to restricted APIs. It is issued by session APIs. For status codes related to this header, refer to the Common Headers Documentation.

Path Parameters

​
sshKeyId
string<uuid>
required

The ID of the SSH key

  • Must be a valid UUID.
Example:

"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"

Body

application/json

The request body for SSH key update.

​
name
string
required

Human-readable name for the SSH key.

Example:

"My Updated SSH key"

Response

Successfully updated the SSH key.