VastAI.update_template

Update an existing template.

Signature

VastAI.update_template(
    HASH_ID: str,
    name: Optional[str] = None,
    image: Optional[str] = None,
    env: Optional[str] = None,
    onstart_cmd: Optional[str] = None,
    search_params: Optional[str] = None,
    disk: Optional[float] = None,
    ssh: bool = False,
    direct: bool = False,
    jupyter: bool = False
) -> str

Parameters

str

required

Hash ID of the template to update.

Optional[str]

New name for the template.

Optional[str]

New Docker image for the template.

Optional[str]

Environment variables to set (formatted as Docker -e flags).

Optional[str]

Shell command to run on instance start.

Optional[str]

Default search query parameters for this template.

Optional[float]

Disk space allocation in GB.

bool

default:"False"

Enable SSH access for instances created from this template.

bool

default:"False"

Enable direct (peer-to-peer) connections.

bool

default:"False"

Enable Jupyter notebook server.

Returns

str, Result from the API call.

Example

from vastai import VastAI

client = VastAI(api_key="YOUR_API_KEY")
result = client.update_template(HASH_ID="...")
print(result)

CLI

SDK

Signature

Parameters

Returns

Example

​Signature

​Parameters

​Returns

​Example

Signature

Parameters

Returns

Example