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.

Perform a self-test on the specified machine.
This is a host method, used for managing machines you are renting out on Vast.ai.

​
Signature

VastAI.self_test_machine(
    machine_id: str,
    debugging: bool = False,
    explain: bool = False,
    raw: bool = False,
    url: str = "https://console.vast.ai",
    retry: int = 3,
    ignore_requirements: bool = False
) -> str

​
Parameters

​
machine_id
str
required
ID of the machine to self-test.
​
debugging
bool
default:"False"
Enable debug output during the test.
​
explain
bool
default:"False"
Print verbose explanations of API calls made.
​
raw
bool
default:"False"
Return raw JSON responses.
​
url
str
default:"\"https://console.vast.ai\""
API server URL.
​
retry
int
default:"3"
Number of retry attempts for failed API requests.
​
ignore_requirements
bool
default:"False"
Skip requirement checks during the test.

​
Returns

str, Result from the API call.

​
Example

from vastai import VastAI

client = VastAI(api_key="YOUR_API_KEY")
result = client.self_test_machine(machine_id="...")
print(result)