Give Feedback

pydo.ssh_keys.update()

Generated on 9 Jun 2026 from pydo version v0.36.0

Copy page as Markdown View page as Markdown

Usage

client.ssh_keys.update(
    ssh_key_identifier=512189,
    body={
        "name": "My SSH Public Key",
    },
)

Returns JSONRaises HttpResponseError

Description

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

Parameters

ssh_key_identifier object required

Either the ID or the fingerprint of an existing SSH key.

name string optional

Example: My SSH Public Key

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

Request Sample

Show Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

req = {
  "name": "My SSH Public Key"
}

resp = client.ssh_keys.update(ssh_key_identifier=512190, body=req)

Response Example

Show Response Example

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

More Information

See /v2/account/keys/{ssh_key_identifier} in the API reference for additional detail on responses, headers, parameters, and more.