---
title: "Changes to Execute a command inside a VM using WebSocket protocol"
method: GET
path: "/vms/{name}/exec"
---

# Changes to Execute a command inside a VM using WebSocket protocol

`GET /vms/{name}/exec`

> Every recorded change to this operation, newest first.

## Timeline

Changed in 5 of 42 revisions.

- **2026-09-09** `27ee74d1b0ca`: 1 breaking, 6 warning, 5 info
- **2026-05-05** `4dc9d4b10d02`: 1 breaking, 8 info
- **2026-05-04** `a4f7b823bb7c`: 2 breaking, 10 info
- **2026-02-12** `06df38f97806`: 1 info
- **2023-01-26** `4b9547159dde`: 1 breaking

## Changes

- **2026-09-09** `27ee74d1b0ca`: 1 breaking, 6 warning, 5 info
  - the `query` request parameter `command` became required
  - deleted the `query` request parameter `cmux_session_id`
  - deleted the `query` request parameter `session`
  - removed the optional property `oneOf[#/components/schemas/ExecControllerFrame]/oneOf[#/components/schemas/ExecControllerFrameError]/watermark` from the response with the `101` status
  - removed the optional property `oneOf[#/components/schemas/ExecControllerFrame]/oneOf[#/components/schemas/ExecControllerFrameExit]/watermark` from the response with the `101` status
  - removed the optional property `oneOf[#/components/schemas/ExecControllerFrame]/oneOf[#/components/schemas/ExecControllerFrameStderr]/watermark` from the response with the `101` status
  - removed the optional property `oneOf[#/components/schemas/ExecControllerFrame]/oneOf[#/components/schemas/ExecControllerFrameStdout]/watermark` from the response with the `101` status
  - removed the non-success response with the status `409`
  - removed `history, ack, detach, close` discriminator mapping keys from the `oneOf[#/components/schemas/ExecClientFrame]/` response property for the response status `101`
  - removed `no_more_history` discriminator mapping keys from the `oneOf[#/components/schemas/ExecControllerFrame]/` response property for the response status `101`
  - removed `#/components/schemas/ExecClientFrameHistory, #/components/schemas/ExecClientFrameAck, #/components/schemas/ExecClientFrameDetach, #/components/schemas/ExecClientFrameClose` from the `oneOf[#/components/schemas/ExecClientFrame]/` response property `oneOf` list for the response status `101`
  - removed `#/components/schemas/ExecControllerFrameNoMoreHistory` from the `oneOf[#/components/schemas/ExecControllerFrame]/` response property `oneOf` list for the response status `101`
- **2026-05-05** `4dc9d4b10d02`: 1 breaking, 8 info
  - added `#/components/schemas/ExecClientFrameResize` to the `oneOf[#/components/schemas/ExecClientFrame]/` response property `oneOf` list for the response status `101`
  - added the new optional `query` request parameter `cols`
  - added the new optional `query` request parameter `env`
  - added the new optional `query` request parameter `interactive`
  - added the new optional `query` request parameter `rows`
  - added the new optional `query` request parameter `tty`
  - added the new optional `query` request parameter `workdir`
  - `query` request parameter `stdin` was deprecated
  - added `resize` discriminator mapping keys to the `oneOf[#/components/schemas/ExecClientFrame]/` response property for the response status `101`
- **2026-05-04** `a4f7b823bb7c`: 2 breaking, 10 info
  - added `#/components/schemas/ExecClientFrameHistory, #/components/schemas/ExecClientFrameAck, #/components/schemas/ExecClientFrameDetach, #/components/schemas/ExecClientFrameClose` to the `oneOf[#/components/schemas/ExecClientFrame]/` response property `oneOf` list for the response status `101`
  - added `#/components/schemas/ExecControllerFrameNoMoreHistory` to the `oneOf[#/components/schemas/ExecControllerFrame]/` response property `oneOf` list for the response status `101`
  - added the new optional `query` request parameter `cmux_session_id`
  - added the new optional `query` request parameter `session`
  - the `query` request parameter `command` became optional
  - added the non-success response with the status `409`
  - added the optional property `oneOf[#/components/schemas/ExecControllerFrame]/oneOf[#/components/schemas/ExecControllerFrameError]/watermark` to the response with the `101` status
  - added the optional property `oneOf[#/components/schemas/ExecControllerFrame]/oneOf[#/components/schemas/ExecControllerFrameExit]/watermark` to the response with the `101` status
  - added the optional property `oneOf[#/components/schemas/ExecControllerFrame]/oneOf[#/components/schemas/ExecControllerFrameStderr]/watermark` to the response with the `101` status
  - added the optional property `oneOf[#/components/schemas/ExecControllerFrame]/oneOf[#/components/schemas/ExecControllerFrameStdout]/watermark` to the response with the `101` status
  - added `history, ack, detach, close` discriminator mapping keys to the `oneOf[#/components/schemas/ExecClientFrame]/` response property for the response status `101`
  - added `no_more_history` discriminator mapping keys to the `oneOf[#/components/schemas/ExecControllerFrame]/` response property for the response status `101`
- **2026-02-12** `06df38f97806`: 1 info
  - endpoint added
- **2023-01-26** `4b9547159dde`: 1 breaking
  - api path removed without deprecation

---

[Operation](https://skmtc.dev/openai/apis/orchard/docs/vms/:name/exec/get.md) - [API](https://skmtc.dev/openai/apis/orchard.md) - [Page](https://skmtc.dev/openai/apis/orchard/changes/vms/:name/exec/get)