v1

latestOpenAPI 3.1.0MIT2026-08-0481194343.8 KB

machines

Get SSH key + VNC password (HIGH-RISK)

Managed machines only. External machines return 409 INVALID_STATE because Coasty never issues SSH, VNC, WebSocket, or browser-debug credentials for caller-owned devices. For managed machines, returns plaintext credentials gated by connection:read; the response is Cache-Control: no-store. Store credentials in a secrets manager — Coasty cannot re-issue them; rotate by terminating + reprovisioning.

get/v1/machines/{machine_id}/connection

Response

Connection details.

machine_idstring required

public_ipstring nullable

ssh_portinteger nullable

ssh_usernamestring nullable

ssh_private_key_pemstring nullable

ED25519 (Linux) or RSA (Windows) private key. HIGHLY SENSITIVE — store in a secrets manager.

vnc_portinteger nullable

vnc_passwordstring nullable

websocket_portinteger nullable

websocket_urlstring nullable

devtools_urlstring nullable

vnc_urlstring nullable

When available, a signed, short-lived, INTERACTIVE noVNC desktop URL (targets /vnc.html?autoconnect=1). Open directly in a browser or iframe to view AND control the desktop — no IP/port/password needed. Null when not available for this machine (use public_ip + vnc_port + vnc_password instead). Expires (~1h); re-fetch from this endpoint to refresh.

screen_widthinteger nullable

Actual desktop width, when reported by the machine.

screen_heightinteger nullable

Actual desktop height, when reported by the machine.

request_idstring required