Account

API Reference

GPU Droplets

Account

AccountKeys

Create a New SSH Key

client.gpuDroplets.account.keys.create(KeyCreateParams { name, public_key } body, RequestOptionsoptions?): KeyCreateResponse { ssh_key }

post/v2/account/keys

Delete an SSH Key

client.gpuDroplets.account.keys.delete(number | stringsshKeyIdentifier, RequestOptionsoptions?): void

delete/v2/account/keys/{ssh_key_identifier}

List All SSH Keys

client.gpuDroplets.account.keys.list(KeyListParams { page, per_page } query?, RequestOptionsoptions?): KeyListResponse { meta, links, ssh_keys }

get/v2/account/keys

Retrieve an Existing SSH Key

client.gpuDroplets.account.keys.retrieve(number | stringsshKeyIdentifier, RequestOptionsoptions?): KeyRetrieveResponse { ssh_key }

get/v2/account/keys/{ssh_key_identifier}

Update an SSH Key's Name

client.gpuDroplets.account.keys.update(number | stringsshKeyIdentifier, KeyUpdateParams { name } body, RequestOptionsoptions?): KeyUpdateResponse { ssh_key }

put/v2/account/keys/{ssh_key_identifier}

ModelsExpand Collapse

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.