Skip to main content
Search for template results using custom query

Usage

vastai search templates [--help] [--api-key API_KEY] [--raw] <query>

Arguments

query
string
required
Search query in simple query syntax (see below)

Description

Query syntax: query = comparison comparison… comparison = field op value field = <name of a field> op = one of: <, <=, ==, !=, >=, >, in, notin value = <bool, int, float, string> | ‘any’ | [value0, value1, …] bool: True, False note: to pass ’>’ and ’<’ on the command line, make sure to use quotes note: to encode a string query value (ie for gpu_name), replace any spaces ’ ’ with underscore ’_‘

Examples

# search for somewhat reliable single RTX 3090 instances, filter out any duplicates or offers that conflict with our existing stopped instances
        vastai search templates 'count_created > 100  creator_id in [38382,48982]'

    Available fields:

  Name                  Type       Description

creator_id              int        ID of creator
created_at              float      time of initial template creation (UTC epoch timestamp)
count_created           int        #instances created (popularity)
default_tag             string     image default tag
docker_login_repo       string     image docker repository
id                      int        template unique ID
image                   string     image used for template
jup_direct              bool       supports jupyter direct
hash_id                 string     unique hash ID of template
name                    string     displayable name
recent_create_date      float      last time of instance creation (UTC epoch timestamp)
recommended_disk_space  float      min disk space required
recommended             bool       is templated on our recommended list
ssh_direct              bool       supports ssh direct
tag                     string     image tag
use_ssh                 bool       supports ssh (direct or proxy)

Global Options

The following options are available for all commands:
OptionDescription
--url URLServer REST API URL
--retry NRetry limit
--rawOutput machine-readable JSON
--explainVerbose explanation of API calls
--api-key KEYAPI key (defaults to ~/.config/vastai/vast_api_key)