Skip to main content
Machines have four : running, sleeping, starting, and destroyed. You control transitions between them.

List machines

Returns every machine in your account, including sleeping machines.

Get machine details

Returns a point-in-time snapshot of the machine object: ID, phase, CPU, memory, storage, autosleep policy, IP address, and timestamps.
string
required
The machine to retrieve.

Watch

Streams state changes. Use it to monitor sleep, wake, and delete. The stream closes when the machine reaches a stable phase.
string
required
The machine to watch.

Auto-sleep

By default, machines auto-sleep after 5 idle minutes. Set autosleep on create or update. Use never to disable it. Activity includes executions, terminal traffic, SSH traffic, port traffic, and CPU work from user-owned processes inside the VM.
string
Idle window before auto-sleep. Accepts units like 30s, 15m, 2h, 1w3d, raw seconds like "1800", or never.

Sleep

Sleeping machines have zero compute cost. Storage persists. Sleep preserves the machine’s root filesystem. Paths such as /etc, /home, /root, /usr/local, and /var persist unless you mount something else over them. Kernel and runtime filesystems are recreated on each wake. Paths such as /proc, /sys, /dev, /run, and /dev/shm are not persistent storage. Treat /tmp as temporary scratch space; use /var/tmp, /home, /root, or another root-filesystem path for files you need after sleep.

Wake

string
required
The machine to sleep or wake.

Delete

Delete the machine.
string
required
The machine to delete.
Delete removes the machine from normal use immediately. Storage may be retained for up to 30 days. Contact support for recovery.
Last modified on June 30, 2026