0

Update an SSH Key's Name

by
Published Dec 20, 2024

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.

Script digitalocean Verified

The script

Submitted by hugo697 Bun
Verified 536 days ago
1
//native
2
type Digitalocean = {
3
  token: string;
4
};
5
/**
6
 * Update an SSH Key's Name
7
 * 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.
8
 */
9
export async function main(
10
  auth: Digitalocean,
11
  ssh_key_identifier: string,
12
  body: { name?: string },
13
) {
14
  const url = new URL(
15
    `https://api.digitalocean.com/v2/account/keys/${ssh_key_identifier}`,
16
  );
17

18
  const response = await fetch(url, {
19
    method: "PUT",
20
    headers: {
21
      "Content-Type": "application/json",
22
      Authorization: "Bearer " + auth.token,
23
    },
24
    body: JSON.stringify(body),
25
  });
26
  if (!response.ok) {
27
    const text = await response.text();
28
    throw new Error(`${response.status} ${text}`);
29
  }
30
  return await response.json();
31
}
32