v1
latestOpenAPI 3.0.02026-07-17212535.2 KBExecute a command inside a VM using WebSocket protocol
Query parameters
Command to execute.
Required when starting a new exec session. May be omitted when reconnecting to an existing session identified by the session parameter.
Optional stable exec session identifier. When present, websocket disconnects detach from the command instead of terminating it, and later requests with the same VM name and session id may reconnect and request buffered history.
Compatibility alias for session. Prefer session for new Orchard clients.
Whether to allocate an interactive standard input for the command
When enabled, make sure to close the standard input by sending a ExecClientFrameStdin frame with an empty data. Otherwise the command might never terminate waiting for the standard input to end.
Deprecated alias for interactive.
If both interactive and stdin are provided, their values must match.
Whether to allocate a pseudo-terminal for the command
Initial terminal row count when tty=true
Initial terminal column count when tty=true
Environment variables to expose to the command.
Use deep object query syntax, for example env[FOO]=bar&env[BAZ]=qux.
Working directory to switch to before starting the command
Duration in seconds for the VM to become available if it's not available already
Headers
WebSocket protocol required header
WebSocket protocol required header