SSH Keys

Functions for managing SSH keys used for CVM access

​

listSshKeys

GET /user/ssh-keys

Returns all SSH keys associated with the authenticated user.

Parameters: None

Returns: Array of SshKey objects.

Field	Type	Description
id	string	Key identifier
name	string	Key name
public_key	string	Public key content
fingerprint	string	Key fingerprint
created_at	string	Creation timestamp

Example:

const keys = await client.listSshKeys();
keys.forEach(k => console.log(k.name, k.fingerprint));

---

​

createSshKey

POST /user/ssh-keys

Adds a new SSH public key to the user’s account.

Parameters:

Field	Type	Required	Description
name	string	Yes	Display name for the key
public_key	string	Yes	SSH public key content

Returns: SshKey — the created key with computed fingerprint.

Example: Replace the sample public key with your own key before using it for access.

const key = await client.createSshKey({
  name: "my-laptop",
  public_key: "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAID4dR/9d26lbwH5ViDEJgWZqaHI6/Mlr8QyTfE6w8ANk docs-example",
});
console.log(key.fingerprint);

---

​

deleteSshKey

DELETE /user/ssh-keys/{key_id}

Removes an SSH key from the user’s account.

Parameters:

Field	Type	Required	Description
id	string	Yes	Key identifier

Returns: void

---

​

importGithubProfileSshKeys

POST /user/ssh-keys/import/github-profile

Imports SSH public keys from a GitHub user’s profile.

Parameters:

Field	Type	Required	Description
github_username	string	Yes	GitHub username

Returns: ImportGithubProfileResponse — import results with count of keys added.

Example:

const result = await client.importGithubProfileSshKeys({
  github_username: "octocat",
});
console.log(`Imported ${result.imported} keys`);

---

​

syncGithubSshKeys

POST /user/ssh-keys/sync/github

Syncs SSH keys with the authenticated user’s linked GitHub account.

Parameters: None

Returns: SyncGithubSshKeysResponse — sync results.

---

​

getCvmSshKeys

GET /cvms/{cvmId}/ssh-keys

Returns the SSH keys configured for a CVM and a restart_required flag. This is the stored configuration; use getCvmUserConfig to inspect the running VM’s configuration.

import { createClient, getCvmSshKeys } from "@phala/cloud";

const client = createClient();
const result = await getCvmSshKeys(client, { id: "my-app" });
console.log(result.keys, result.restart_required);

​

updateCvmSshKeys

PUT /cvms/{cvmId}/ssh-keys

Replaces the configured key set. ssh_key_ids is required. Optional usernames resolve to members’ keys and are added to the set. Keys take effect at the next power-on; set apply_now to restart the CVM and apply them immediately.

import { createClient, updateCvmSshKeys } from "@phala/cloud";

const client = createClient();
const result = await updateCvmSshKeys(client, {
  id: "my-app",
  ssh_key_ids: [process.env.SSH_KEY_ID!],
  apply_now: false,
});
console.log(result.restart_required);

Both actions also have safe variants: safeGetCvmSshKeys and safeUpdateCvmSshKeys.