Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vast.ai/llms.txt

Use this file to discover all available pages before exploring further.

Show all instances. Returns a list of instance objects. Key status fields per instance: actual_status, current container state:
ValueMeaning
nullInstance is being provisioned
loadingDocker image is downloading or container is starting up
runningContainer is actively executing. GPU charges apply.
stoppedContainer is halted. Disk charges continue; no GPU charges.
frozenContainer is paused with memory preserved. GPU charges apply.
exitedContainer process exited unexpectedly
rebootingContainer is restarting (transient)
unknownNo recent heartbeat from the host
offlineHost machine disconnected from Vast servers (computed, not stored in DB)
intended_status, user’s desired target state: 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.

​
Signature

VastAI.show_instances(quiet: bool = False) -> str

​
Parameters

​
quiet
bool
default:"False"
quiet

​
Returns

str, Result from the API call.

​
Example

from vastai import VastAI

client = VastAI(api_key="YOUR_API_KEY")
result = client.show_instances()
print(result)