> ## Documentation Index
> Fetch the complete documentation index at: https://team.k0labs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List VMs

> List virtual machines in the region



## OpenAPI

````yaml api-docs/archived/arc.json get /v1/regions/{region}/compute/vms
openapi: 3.1.1
info:
  title: Compute API
  version: 1.0.0
  description: >-
    Compute API for the k0rdent Enterprise platform. Provides Kubernetes cluster
    lifecycle management, virtual machine operations, and software-defined
    networking (SDN) including subnets, IPAM, load balancing, peering,
    interconnects, and firewalls.
  contact:
    name: k0rdent Enterprise API Support
    email: api-support@example.com
    url: https://support.example.com
  license:
    name: Proprietary
    url: https://k0rdent.example.com/license
servers:
  - url: ''
    description: For documentation only
  - url: https://api.example.com
    description: Arc API Base URL
  - url: https://api.internal.example.com
    description: Atlas API Base URL
  - url: http://localhost:{port}
    description: Local Development
    variables:
      port:
        default: '4005'
        description: Compute service port
security: []
paths:
  /v1/regions/{region}/compute/vms:
    get:
      tags:
        - Virtual Machines
      summary: List VMs
      description: List virtual machines in the region
      operationId: listVMs
      parameters:
        - name: region
          in: path
          required: true
          schema:
            type: string
          description: Region identifier
        - name: status
          in: query
          schema:
            type: string
            enum:
              - creating
              - running
              - stopped
              - rebooting
              - deleting
              - error
          description: Filter by status
        - name: limit
          in: query
          schema:
            type: number
            default: 50
          description: Maximum results
        - name: offset
          in: query
          schema:
            type: number
            default: 0
          description: Results to skip
      responses:
        '200':
          description: List of VMs
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VM'
                  meta:
                    type: object
                    properties:
                      total:
                        type: number
                      limit:
                        type: number
                      offset:
                        type: number
components:
  schemas:
    VM:
      type: object
      description: Virtual machine
      properties:
        id:
          type: string
          description: VM identifier
        name:
          type: string
          description: VM name
        status:
          type: string
          enum:
            - creating
            - running
            - stopped
            - rebooting
            - deleting
            - error
          description: VM status
        machineType:
          type: string
          description: Machine type/flavor
        image:
          type: string
          description: OS image
        networkId:
          type: string
          nullable: true
          description: Attached network
        ipAddress:
          type: string
          nullable: true
          description: Assigned IP
        sshKeyId:
          type: string
          nullable: true
          description: SSH key for access
        metadata:
          type: object
          nullable: true
          additionalProperties: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - name
        - status
        - machineType
        - image

````