Update an SSH Key's Name

client.gpuDroplets.account.keys.update(, , ?): KeyUpdateResponse { ssh_key }

put/v2/account/keys/{ssh_key_identifier}

To update the name of an SSH key, send a PUT request to either /v2/account/keys/$SSH_KEY_ID or /v2/account/keys/$SSH_KEY_FINGERPRINT. Set the name attribute to the new name you want to use.

ParametersExpand Collapse

sshKeyIdentifier: number | string

A unique identification number for this key. Can be used to embed a specific SSH key into a Droplet.

Accepts one of the following:

number

string

body: KeyUpdateParams { name }

name?: string

A human-readable display name for this key, used to easily identify the SSH keys when they are displayed.

ReturnsExpand Collapse

KeyUpdateResponse { ssh_key }

ssh_key?: SSHKeys { name, public_key, id, fingerprint }

name: string

A human-readable display name for this key, used to easily identify the SSH keys when they are displayed.

public_key: string

The entire public key string that was uploaded. Embedded into the root user's authorized_keys file if you include this key during Droplet creation.

id?: number

A unique identification number for this key. Can be used to embed a specific SSH key into a Droplet.

fingerprint?: string

A unique identifier that differentiates this key from other keys using a format that SSH recognizes. The fingerprint is created when the key is added to your account.

Update an SSH Key's Name

import Gradient from '@digitalocean/gradient';

const client = new Gradient({
  accessToken: 'My Access Token',
});

const key = await client.gpuDroplets.account.keys.update(512189);

console.log(key.ssh_key);

{
  "ssh_key": {
    "name": "My SSH Public Key",
    "public_key": "ssh-rsa AEXAMPLEaC1yc2EAAAADAQABAAAAQQDDHr/jh2Jy4yALcK4JyWbVkPRaWmhck3IgCoeOO3z1e2dBowLh64QAM+Qb72pxekALga2oi4GvT+TlWNhzPH4V example",
    "id": 512189,
    "fingerprint": "3b:16:bf:e4:8b:00:8b:b8:59:8c:a9:d3:f0:19:45:fa"
  }
}

Returns Examples

{
  "ssh_key": {
    "name": "My SSH Public Key",
    "public_key": "ssh-rsa AEXAMPLEaC1yc2EAAAADAQABAAAAQQDDHr/jh2Jy4yALcK4JyWbVkPRaWmhck3IgCoeOO3z1e2dBowLh64QAM+Qb72pxekALga2oi4GvT+TlWNhzPH4V example",
    "id": 512189,
    "fingerprint": "3b:16:bf:e4:8b:00:8b:b8:59:8c:a9:d3:f0:19:45:fa"
  }
}