REreplicas
Commands and terminals

Get SSH access

Returns a short-lived token and proxy command for SSH. The CLI runs this for you. The replica must be active.

post/v1/replica/{id}/ssh-token

Request

  • Base URL
    https://api.replicas.dev
  • URL
    https://api.replicas.dev/v1/replica/{id}/ssh-token
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

Replica ID

Headers

X-Replicas-Api-Version'2026-10-07'

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

Response

Success

tokenstring required

Short-lived token used as the SSH username.

hoststring required

Workspace SSH host.

proxy_commandstring

Optional OpenSSH ProxyCommand for CLI clients.

Changes

No recorded changes to this operation across all 1 revision of this API.