• Make USB accessories opt-in for Tart VMs (#502)latest7Docsf7168252026-09-23 19:24

  Change detail

  7 changes across 4 operations

  AllBreakingWarningInfo

  • GET/vms/{name}
    • info

      added the optional property allOf[subschema #2: Virtual Machine Specification]/usbAccessories to the response with the 200 status (media type: application/json)

    • info

      added the optional property object/allOf[subschema #2: Virtual Machine Specification]/usbAccessories to the response with the 200 status (media type: application/x-ndjson)

  • PUT/vms/{name}
    • info

      added the new optional request property usbAccessories

    • info

      added the optional property allOf[subschema #2: Virtual Machine Specification]/usbAccessories to the response with the 200 status

  • POST/vms
    • info

      added the new optional request property allOf[subschema #2: Virtual Machine Specification]/usbAccessories

    • info

      added the optional property allOf[subschema #2: Virtual Machine Specification]/usbAccessories to the response with the 200 status

  • GET/vms
    • info

      added the optional property items/allOf[subschema #2: Virtual Machine Specification]/usbAccessories to the response with the 200 status

• /exec API: drop session reconnection support (#487)1610Docs4cd43d22026-09-09 07:05

  Change detail

  17 changes across 1 operation and 5 models

  AllBreakingWarningInfo

  • GET/vms/{name}/exec
    • breaking

      the query request parameter command became required

    • warning

      deleted the query request parameter cmux_session_id

    • warning

      deleted the query request parameter session

    • warning

      removed the optional property oneOf[#/components/schemas/ExecControllerFrame]/oneOf[#/components/schemas/ExecControllerFrameError]/watermark from the response with the 101 status

    • warning

      removed the optional property oneOf[#/components/schemas/ExecControllerFrame]/oneOf[#/components/schemas/ExecControllerFrameExit]/watermark from the response with the 101 status

    • warning

      removed the optional property oneOf[#/components/schemas/ExecControllerFrame]/oneOf[#/components/schemas/ExecControllerFrameStderr]/watermark from the response with the 101 status

    • warning

      removed the optional property oneOf[#/components/schemas/ExecControllerFrame]/oneOf[#/components/schemas/ExecControllerFrameStdout]/watermark from the response with the 101 status

  View all changes (17)
• Support Tart Guest Agent transport for VM startup scripts (#490)7Docs9ac6ca62026-09-09 07:04

  Change detail

  7 changes across 4 operations

  AllBreakingWarningInfo

  • GET/vms/{name}
    • info

      added the optional property allOf[subschema #2: Virtual Machine Specification]/startup_script/transport to the response with the 200 status (media type: application/json)

    • info

      added the optional property object/allOf[subschema #2: Virtual Machine Specification]/startup_script/transport to the response with the 200 status (media type: application/x-ndjson)

  • PUT/vms/{name}
    • info

      added the new optional request property startup_script/transport

    • info

      added the optional property allOf[subschema #2: Virtual Machine Specification]/startup_script/transport to the response with the 200 status

  • POST/vms
    • info

      added the new optional request property allOf[subschema #2: Virtual Machine Specification]/startup_script/transport

    • info

      added the optional property allOf[subschema #2: Virtual Machine Specification]/startup_script/transport to the response with the 200 status

  • GET/vms
    • info

      added the optional property items/allOf[subschema #2: Virtual Machine Specification]/startup_script/transport to the response with the 200 status

• Support port-forwarding directly to Tart Guest Agent (#489)1Docs01bf2d72026-09-08 17:40

  Change detail

  1 change across 1 operation

  AllBreakingWarningInfo

  • GET/vms/{name}/port-forward
    • info

      added the new optional query request parameter target

• Make audio and clipboard sharing opt-in (#486)1414Docs792324b2026-09-08 09:24

  Change detail

  28 changes across 4 operations

  AllBreakingWarningInfo

  • GET/vms/{name}
    • warning

      removed the optional property allOf[subschema #2: Virtual Machine Specification]/noAudio from the response with the 200 status (media type: application/json)

    • warning

      removed the optional property allOf[subschema #2: Virtual Machine Specification]/noClipboard from the response with the 200 status (media type: application/json)

    • warning

      removed the optional property object/allOf[subschema #2: Virtual Machine Specification]/noAudio from the response with the 200 status (media type: application/x-ndjson)

    • warning

      removed the optional property object/allOf[subschema #2: Virtual Machine Specification]/noClipboard from the response with the 200 status (media type: application/x-ndjson)

    • info

      added the optional property allOf[subschema #2: Virtual Machine Specification]/audio to the response with the 200 status (media type: application/json)

    • info

      added the optional property allOf[subschema #2: Virtual Machine Specification]/clipboard to the response with the 200 status (media type: application/json)

    • info

      added the optional property object/allOf[subschema #2: Virtual Machine Specification]/audio to the response with the 200 status (media type: application/x-ndjson)

  View all changes (28)
• Add UDP endpoint support (#485)210Docsd8caf2d2026-09-07 11:35
• Support running host processes alongside VMs (#482)9Docsa3e08ff2026-09-02 23:24
• Add endpoint support (#478)14Docs3fe0a282026-09-02 15:08
• Add an option to disable Tart clipboard sharing (#475)7Docs28c0dd32026-09-01 20:32
• Add --no-audio support to VM spec (#460)7Docscc2c0fd2026-09-01 16:17
• Disable host directory sharing by default (#462)no API changesDocs3ec5e3e2026-08-17 21:45
• 0.1.0no API changesDocs2026-07-17 12:03
• Add more options to `/exec` (#435)18Docs2667a012026-05-05 12:56
• Supporting reconnecting to `/exec` socket (#434)210Docse6a33142026-05-04 19:49
• Support Vetu virtualization on Linux in addition to Tart on macOS (#419)33Docs9092a9f2026-03-16 10:12
• controller(api): new "GET /vms/{name}/exec" WebSocket-based endpoint (#408)1Docsa64f76a2026-02-12 12:35
• Implement server-side filtering for VMs by worker (#392)1Docs68823882026-01-29 16:52
• Add pagination support for listing VM events (#386)3Docs6fe523e2026-01-22 14:22
• Ability to set VM's power state and retrieve backing Tart VM's name (#373)12Docs76a552b2025-12-02 21:43
• OpenAPI specification: VMMeta's "name" shouldn't be "readOnly: true"6Docsdbb180b2025-11-11 18:49
• OpenAPI specification: document requestBody for POST/PUT methods (#368)84Docs3f1b4b42025-11-11 18:44
• VM specification: allow suspendable VMs (#366)5Docs60303d12025-11-11 17:16
• Simplify state reconciliation and support changing Softnet settings (#364)1155Docsbafcf6f2025-11-06 16:56
• Support "tart run"'s --net-softnet-allow and --net-softnet-block (#361)20Docs08e9dfb2025-10-27 19:07
• API: document VM's "startup_script" (#358)5Docs1df191c2025-10-07 11:26
• API spec: document VM object more thoroughly (#354)85Docs6d235482025-10-06 14:22
• API: introduce ability to watch a VM (#351)4Docsc5e0d682025-10-03 17:34
• orchard create vm: "--nested" flag to enable nested virtualization (#346)4Docs43e21c72025-09-26 15:42
• Worker notification improvements (#246)2Docs8dd74db2025-02-06 20:38
• Small timout for worker notification (#242)1Docs86f0afb2025-02-06 17:30
• Introduce WebSocket-based RPC v2 (#239)1Docs88fba802025-01-30 13:33
• Fix OpenAPI spec errors reported by Swagger Editor (#213)no API changesDocs79213fc2024-10-31 22:20
• API endpoint and associated RPC changes to resolve VMs IP's (#188)1Docs76f192b2024-07-03 18:56
• Introduce "orchard {port-forward, vnc} worker WORKER_NAME" (#140)1737Docs13b4e192023-10-09 14:51
• Support for sharing files with the host system (#103)2Docsd57d18d2023-07-04 14:10
• Controller info endpoint and API integration examples (#75)1Docs77656512023-04-11 07:28
• Make port-forward endpoint to wait for the VM (#65)1Docs5eaf6b22023-03-27 19:52
• Resources support (#63)no API changesDocscb398362023-03-27 13:30
• Port forwarding support (#30)1Docs47fef472023-03-14 15:31
• Events Entity (#28)2Docs05821082023-03-13 12:04
• Introduce service accounts and bootstrap tokens (#22)5Docs8df31f72023-02-21 16:34
• Initial version of the Orchard orchestration system (#3)22529Docs92e87322023-01-26 19:46

Revisions go back to the API's first capture.