NOnodus-compute
Research workspaces

Connect an authenticated SSH stream to the current workspace session

Upgrades an authenticated request to a WebSocket using nodus-workspace-ssh-v1. Binary messages carry the SSH byte stream. Use the session and generation from a fresh SSH connection response. Query strings, Origin and Cookie headers are rejected. Authorization must contain one current Bearer credential. Nodus checks workspace ownership and the pinned session before connecting and while forwarding. The guest still authenticates the customer's SSH public key. Either side closing or authorization expiry closes the stream. The CLI proxy opens this endpoint without a browser or credential in its command line.

get/v1/research-workspaces/{id}/ssh-stream

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    HTTP bearer

Path parameters

idstring required

Headers

X-Nodus-Workspace-Sessionstring required

Pinned compute session identifier from the SSH connection response.

X-Nodus-Workspace-Generationstring required

Exact positive decimal session generation from the SSH connection response.

Sec-WebSocket-Protocol'nodus-workspace-ssh-v1' required

Response

400 invalid_ssh_connection for an invalid handshake identity. 409 workspace_not_ready for a stale or unavailable session. 503 ssh_unavailable when the stream or guest is unavailable. Authentication and rate limits also apply.

codestring required
messagestring required
fixstring required
urlstring uri required

Changes

No recorded changes to this operation across all 70 revisions of this API.