Skip to main content
POST
Get SSH access

Authorizations

Authorization
string
header
required

Organization or personal API key from Settings → API Keys.

Headers

X-Replicas-Api-Version
enum<string>

API version. 2026-10-07 returns snake_case responses. See versioning.

Available options:
2026-10-07

Path Parameters

id
string<uuid>
required

Replica ID

Response

Success

token
string
required

Short-lived token used as the SSH username.

host
string
required

Workspace SSH host.

proxy_command
string

Optional OpenSSH ProxyCommand for CLI clients.

transport
object