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

# List test vms.

`GET /vms`

Required RBAC Policy: kots/vm/list

## Response `200`

ListVMsResponse contains the response to list vms

- object
  - `error` string
  - `totalVMs` integer
  - `vms` VM[]
    - `actor` Actor
      - `description` string
      - `id` string
      - `link` string
      - `timestamp` string, date-time
      - `type` string
    - `addons` VMAddon[]
      - `created_at` string, date-time
      - `guid` string
      - `id` string
      - `port` VMAddonPort
        - `name` string
        - `protocol_http` boolean
        - `protocol_https` boolean
        - `protocol_ws` boolean
        - `protocol_wss` boolean
        - `upstream_port` integer
      - `ready_at` string, date-time
      - `status` string
      - `terminated_at` string, date-time
      - `total_credits` integer
      - `vm_guid` string
      - `vm_id` string
    - `assigned_at` string, date-time
    - `created_at` string, date-time
    - `credits_per_hour` integer
    - `direct_ssh_endpoint` string
    - `direct_ssh_port` integer
    - `disk_gib` integer
    - `distribution` string
    - `expires_at` string, date-time
    - `flat_fee` integer
    - `guid` string
    - `id` string
    - `instance_type` string
    - `last_scheduling_status` string
    - `name` string
    - `network_id` string
    - `running_at` string, date-time
    - `status` string
    - `tags` Tag[]
      - `key` string
      - `value` string
    - `team_id` string
    - `total_credits` integer
    - `ttl` string
    - `version` string

## Other responses

- `400` — Returned on bad input
- `401` — Return if the caller is not authorized
- `403` — Returned if the caller does not have the needed permission
- `404` — Returned on resource not found

---

[API](https://skmtc.net/replicated/apis/vendor-api-v3-2.md) · [All operations](https://skmtc.net/replicated/apis/vendor-api-v3-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/replicated/vendor-api-v3-2/versions/6fcf9e54aba4/schema)