VastAI.show_instances_v1

Show instances with pagination and filtering (v1). 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)

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_v1(
    quiet: bool = False,
    verbose: bool = False,
    all: bool = False,
    status: Optional[List[str]] = None,
    label: Optional[List[str]] = None,
    gpu_name: Optional[List[str]] = None,
    verification: Optional[List[str]] = None,
    limit: Optional[int] = None,
    next_token: Optional[str] = None,
    order_by: Optional[str] = None,
    cols: Optional[str] = None
) -> str

Parameters

quiet

bool

default:"False"

Only print instance IDs, one per line.

verbose

bool

default:"False"

Show additional columns (SSH, location, template, etc.).

all

bool

default:"False"

Fetch all pages automatically and send to pager.

status

Optional[List[str]]

Filter by container status: running, loading, exited.

label

Optional[List[str]]

Filter by instance label; pass empty string to match unlabeled.

gpu_name

Optional[List[str]]

Filter by GPU model name (e.g. ‘RTX A5000’).

verification

Optional[List[str]]

Filter by machine verification: verified, unverified, deverified.

limit

Optional[int]

Max instances per page (1-25, default 25).

next_token

Optional[str]

Resume from a pagination token from a previous page.

order_by

Optional[str]

Sort column with optional direction, e.g. ‘start_date desc’.

cols

Optional[str]

Override displayed columns with a comma-separated list.

Returns

str, Result from the API call.

Example

from vastai import VastAI

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

CLI

SDK

Signature

Parameters

Returns

Example

​Signature

​Parameters

​Returns

​Example

Signature

Parameters

Returns

Example