---
title: "List VMs"
method: GET
path: "/vms"
tags: ["vms"]
---

# List VMs

`GET /vms`

## Response `200`

OK

- VM[]
  - `name` string — VM name
  - `resources` object — Dictionary that maps the resource name to the amount of this resource required on the worker for this VM to be scheduled
  - `hostDirs` object[]
    - `name` string
    - `path` string
    - `ro` boolean

## Changes

- **2023-10-09** `e0632c7e52ea` — 1 breaking, 3 info
  - the `items/` response's property type/format changed from ``/`` to `object`/`` for status `200`
  - added the optional property `items/hostDirs` to the response with the `200` status
  - added the optional property `items/name` to the response with the `200` status
  - added the optional property `items/resources` to the response with the `200` status
- **2023-01-26** `4b9547159dde` — 1 breaking, 1 warning, 1 info
  - the `items/` response's property type/format changed from `object`/`` to ``/`` for status `200`
  - deleted the `query` request parameter `filter`
  - removed `#/components/schemas/VMMeta, #/components/schemas/VMSpec, #/components/schemas/VMState` from the `items/` response property `allOf` list for the response status `200`

[Change history](https://skmtc.dev/openai/apis/orchard/changes/vms/get.md)

---

[API](https://skmtc.dev/openai/apis/orchard.md) · [All operations](https://skmtc.dev/openai/apis/orchard/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/openai/orchard/revisions/9d2bc7a08ffc/schema)