Sign in

v12

latestOpenAPI 3.0.3raw.githubusercontent.com2026-06-1811583196.1 KB
Virtual Machines

List VMs

List all virtual machines for the authenticated account.

get/api/v1/vms

Query parameters

project_idstring uuid

Filter by project ID

region'us-east'

Filter by region

status'active' | 'passive' | 'provisioning' | 'booting' | 'initiating' | 'finalizing' | 'failure'

Filter by VM status. Values: initiating (queued/setup), provisioning (being created), booting (starting), active (running), passive (stopped), finalizing (shutting down), failure (failed).

limitinteger

Maximum number of VMs to return

offsetinteger

Number of VMs to skip for pagination

Response

List of VMs

successboolean

Whether the request was successful

totalinteger

Total number of VMs matching the query

Example response

{
  "data": [
    {
      "name": "my-ubuntu-server",
      "cpu": 2,
      "ram": 4,
      "storage": 80,
      "total_storage": 80,
      "template_name": "Ubuntu",
      "template_version": "24.10x64",
      "price_per_hour": "0.027764",
      "pricing_id": 3,
      "billing_type": "payg",
      "backup_type": "weekly",
      "region": "us-east",
      "public_ipv4_address": "15.204.178.3",
      "private_ipv4_address": "10.10.0.96"
    }
  ]
}