VMs

List your VMs.

get/v5/vms

Query parameters

state'starting' | 'running' | 'pausing' | 'paused' | 'stopped'

Only VMs in this state.

slugstring

Exact slug match.

searchstring
snapshotIdstring

Only VMs booted from this snapshot.

vpcstring

Only VMs attached to this network (id, or your slug for it).

metadatastring

Comma-separated key:value pairs, e.g. env:prod,region:us-west.

limitinteger
offsetinteger

Response

The account's VMs, with per-state counts

pausedCountinteger required
pausingCountinteger
runningCountinteger required
startingCountinteger required
stoppedCountinteger required
totalCountinteger required

Changes

No recorded changes to this endpoint across all 1 revision of this API.