Usage
Options
Only print instance IDs, one per line (alias:
--quiet)Show additional columns (SSH, location, template, etc.) (alias:
--verbose)Fetch all pages automatically and send to pager (alias:
--all)Filter by container status. Choices:
running, loading, exitedFilter by instance label; pass empty string to match unlabeled
Filter by GPU model name (e.g.
RTX A5000)Filter by machine verification. Choices:
verified, unverified, deverifiedMax instances per page (1–25, default 25)
Resume from a pagination token from a previous page
Sort column with optional direction, e.g.
start_date descOverride displayed columns with a comma-separated list
Description
Returns a paginated list of instance objects. Key status fields per instance: actual_status — current container state:| Value | Meaning |
|---|---|
null | Instance is being provisioned |
loading | Docker image is downloading or container is starting up |
running | Container is actively executing. GPU charges apply. |
stopped | Container is halted. Disk charges continue; no GPU charges. |
frozen | Container is paused with memory preserved. GPU charges apply. |
exited | Container process exited unexpectedly |
rebooting | Container is restarting (transient) |
unknown | No recent heartbeat from the host |
offline | Host machine disconnected from Vast servers (computed, not stored in DB) |
running, stopped, or frozen.
cur_state — machine contract / hardware allocation state: running, stopped, or unloaded (released on destroy).
status_msg — human-readable detail on the current status.
Examples
Global Options
The following options are available for all commands:| Option | Description |
|---|---|
--url URL | Server REST API URL |
--retry N | Retry limit |
--raw | Output machine-readable JSON |
--explain | Verbose explanation of API calls |
--api-key KEY | API key (defaults to ~/.config/vastai/vast_api_key) |