Skip to main content
POST
Add an SSH connection

Authorizations

Authorization
string
header
required

Your Reason API key from Settings > API. New keys use reason_; legacy ara_ keys remain accepted. Keys are capability-scoped: run, mcp:read, mcp:write, secrets:read, secrets:write, sessions:read, sessions:debug, knowledge:read, memory:read, memory:write, skills:read, skills:write, repos:read, repos:write, reviews:read, reviews:write, deployment:read, analytics:read, org:read, org:write, attachments:read, attachments:write, guardrails:read, guardrails:write, automations:read, automations:write, agent_auth:read. mcp:write manages MCP server configuration only; it does not authorize remote MCP-tool execution. sessions:debug is privileged: it expands diagnostic session events only for organization owners/admins.

Path Parameters

orgId
string
required

Organization id or slug. Resolve it with GET /v3/self.

Body

application/json
name
string
required
Required string length: 1 - 160
host
string
required
Required string length: 1 - 253
Pattern: ^[a-zA-Z0-9.:_-]+$
username
string
required

SSH username, up to 64 characters, or Railway's sbx:: routing selector.

Required string length: 1 - 77
authentication
object
required
idempotency_key
string
required

Persist one non-secret key per logical request. Retry the identical body/key for up to 24 hours. Expired or deleted request keys return 409; reconnect intentionally with a fresh key.

Required string length: 1 - 160
Pattern: ^[A-Za-z0-9._:-]+$
port
integer
default:22
Required range: 1 <= x <= 65535
workspace_path
string

Optional absolute remote workspace path. Omit to use the installer's private default workspace.

Required string length: 1 - 1024

Response

Original saved receipt replayed.

connection
object
required
replayed
boolean
required