Skip to content

Rename an SSH key

Set an SSH key's label.

Parameters

#
keystringRequired
Active SSH key ID or exact label from ssh-key view. Use the ID if the label identifies more than one key.
labelstringRequired
New SSH key label, from 1 to 200 bytes on one line.

Returns

#
dataobjectAlways present
A saved setting.
Show 1 attributeHide attributes
updatedbooleanAlways present
Whether the request saved the setting.

Errors

#
CodeStatusWhat happened
invalid400An input is missing or invalid.
unauthenticated401The credential is missing, invalid, expired or revoked.
denied403The caller lacks permission for this action.
not_found404The resource is absent or inaccessible to this caller.
conflict409The request conflicts with the current resource state or an earlier request.
over_capacity409The request exceeds a resource or credential allowance.
access_list_full409The change would exceed the access-list allowance.
payment_required402Payment or credit is required.
rate_limited429The caller's request rate exceeds its limit.
busy429Too much work is in progress to accept this request.
unknown503The outcome is unconfirmed; a change may have happened.
unavailable503The service or requested feature is unavailable.

Notes

#
  • API key permission: ssh-key rename.