Skip to main content
GET
Get SSH settings
Returns the computer’s Direct SSH settings. When SSH is on, ssh_command is the command to connect, ssh -p <port> root@<host>. The keys themselves are never returned. Direct SSH is for Linux computers. Owners and editors of the workspace can read it.
Use ipv4_port. Port 22 on ipv4_host is not your computer.
After SSH is turned off, the last port and command can still be returned. Check enabled before you use them. If the computer moves to another server, its host and port can change, so read them again rather than caching them.

Authorizations

Authorization
string
header
required

API key authentication. Get your key at orgo.ai/workspaces

Path Parameters

id
string
required

Computer ID. Accepts the computer's UUID or its instance_id.

Response

SSH settings

enabled
boolean

Whether SSH is on.

authorized_key_set
boolean

Whether a public key is saved. The keys themselves are never returned.

ipv4_host
string | null

The address to connect to: the server the computer runs on.

ipv4_port
integer | null

The computer's SSH port. Null until SSH has been turned on once. It is kept after SSH is turned off, so check enabled.

ipv6_address
string | null

Always null for now.

ssh_user
string

The user to log in as: root on Linux. Can be absent on some dedicated computers.

ssh_command
string | null

The command to connect, ssh -p <port> root@<host>. Null until SSH has been turned on once. It is still filled in after SSH is turned off, so check enabled before you use it.