machines
Open an interactive terminal.
Changed onUpgrades to a WebSocket running a program on a pseudo-terminal in the machine. Requires the machine:exec scope.
get/v1/machines/{id}/exec/interactive
Request
- Base URLhttps://api.smolmachines.com
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring required
Machine id
Query parameters
cmdstring
Program to run, a single path with no arguments (default: /bin/sh). command is accepted as an alias.
colsinteger
Initial terminal width in columns
rowsinteger
Initial terminal height in rows
access_tokenstring
API key, for clients that cannot set an Authorization header on a WebSocket, such as browsers
smol_tenantstring
The account to act in, for a browser that cannot set the Smol-Tenant header on a WebSocket. Accepted on this handshake only, and only when the header is absent; a value that is not an account id is refused with 400
Changes
- info
endpoint added
- info