Skip to main content
POST
Turn on SSH
Saves your public key and turns on Direct SSH. Call it again with new keys to update them: the keys you send replace the keys on the computer. If the answer asks for a restart, the old keys keep working until the computer restarts. Send the public key only (the contents of a .pub file). To allow more than one key, put one per line. When the answer says requires_restart: true, the key could not be put on the running computer yet. Restart the computer once and it is in place. Then read Get SSH settings for the command to connect. Linux computers only. Owners and editors of the workspace only; view only members and share link guests are refused.

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.

Body

application/json
public_key
string
required

One or more OpenSSH public keys, one per line, 16 KB at most: ssh-ed25519, ssh-rsa, ecdsa-sha2-*, sk-ssh-ed25519@openssh.com or sk-ecdsa-sha2-*@openssh.com. Never a private key.

Response

Saved

enabled
boolean
authorized_key_set
boolean
ssh_host_port
integer | null

The computer's SSH port, when the server reported it.

pending
boolean

True when the key could not be put on the running computer yet. It lands on the next start.

requires_restart
boolean

Same as pending: restart the computer once to use the key.