Update

API Reference

GPU Droplets

Account

Keys

Update an SSH Key's Name

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.

Path ParametersExpand Collapse

ssh_key_identifier: number or 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:

SSHKeyID = number

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

SSHKeyFingerprint = 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.

Body ParametersExpand Collapse

name: optional string

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

ReturnsExpand Collapse

ssh_key: optional 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: optional number

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

fingerprint: optional 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

http

• http
• typescript
• python

curl https://api.digitalocean.com/v2/account/keys/$SSH_KEY_IDENTIFIER \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $DIGITALOCEAN_ACCESS_TOKEN" \
    -d '{
          "name": "My SSH Public Key"
        }'

200 example

{
  "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

200 example

{
  "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"
  }
}