Skip to content

Remove an SSH key

Revoke an SSH key by ID. This also revokes tokens signed with that key.

Parameters

#
keystringRequired
The key's ID (see ssh-key view).

Returns

#
dataobjectAlways present
A revoked key that can no longer sign in.
Show 1 attributeHide attributes
revokedbooleanAlways present
True after the key has been revoked.

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 remove.