Skip to main content
PATCH
Update SSH key

Authorizations

Authorization
string
header
required

JWT authentication token

Path Parameters

id
string<uuid>
required

Body

application/json
default_host
string

Default SSH host for connections using this key

Maximum string length: 255
default_port
integer

Default SSH port

Required range: 1 <= x <= 65535
default_username
string

Default SSH username for connections using this key

Maximum string length: 128
host_key_fingerprint
string

Independently verified server host-key fingerprint. Shared connections require a pin.

Pattern: ^$|^SHA256:[A-Za-z0-9+/]{43}$
name
string

New unique name for this SSH connection

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9][A-Za-z0-9_.-]*$
password
string

New SSH password for password-based auth. Not accepted for generated-key auth.

Required string length: 1 - 1000
visibility
enum<string>

Owner-controlled sharing for personal connections; project keys retain project authorization.

Available options:
private,
team

Response

SSH key updated successfully

algorithm
enum<string>
required
Available options:
ed25519,
rsa-2048,
rsa-4096,
ecdsa-256,
ecdsa-384,
ecdsa-521,
password
auth_type
enum<string>
required

Authentication type (key = generated key pair, password = password-based)

Available options:
key,
password
id
string<uuid>
required
is_owned
boolean
required

Whether the caller owns this original resource.

name
string
required
owner_email
string
required
visibility
enum<string>
required
Available options:
private,
team
created_at
string<date-time>
default_host
string | null
default_port
integer | null
default_username
string | null
fingerprint
string | null

SHA256 fingerprint of the public key (null for password auth)

host_key_fingerprint
string

Trusted server host-key SHA256 fingerprint; required for shared execution.

project_id
string<uuid> | null
public_key
string | null

OpenSSH authorized_keys format public key (null for password auth)

team_id
string<uuid> | null