Skip to main content
GET
List VMs
Updated May 8, 2026

Authorizations

X-API-Key
string
header
required

API key for authentication. Each key is bound to a specific account.

Query Parameters

project_id
string<uuid>

Filter by project ID

region
enum<string>

Filter by region

Available options:
us-east
status
enum<string>

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

Available options:
active,
passive,
provisioning,
booting,
initiating,
finalizing,
failure
limit
integer
default:20

Maximum number of VMs to return

offset
integer
default:0

Number of VMs to skip for pagination

Response

List of VMs

success
boolean

Whether the request was successful

data
object[]
total
integer

Total number of VMs matching the query

Last modified on May 8, 2026