search templates

Searches for templates using filter-based queries.

Use select_filters to search by specific field conditions. Results include both your own templates and publicly shared templates.

Available filter fields: creator_id, created_at, count_created, default_tag, docker_login_repo, id, image, jup_direct, hash_id, name, recent_create_date, recommended_disk_space, recommended, ssh_direct, tag, use_ssh

Operators: eq, neq, lt, lte, gt, gte, in, notin

For detailed usage, see Creating and Using Templates with API.

CLI Usage: vastai search templates

GET /api/v0/template

search templates

cURL

curl --request GET \
  --url https://console.vast.ai/api/v0/template \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://console.vast.ai/api/v0/template"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://console.vast.ai/api/v0/template', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://console.vast.ai/api/v0/template",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://console.vast.ai/api/v0/template"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://console.vast.ai/api/v0/template")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://console.vast.ai/api/v0/template")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "success": true,
  "templates_found": 5,
  "templates": [
    {
      "id": 123,
      "name": "<string>",
      "image": "<string>"
    }
  ]
}

{
  "success": false,
  "error": "<string>",
  "msg": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "msg": "<string>"
}

{
  "detail": "API requests too frequent endpoint threshold=3.0"
}

Authorizations

Authorization · string · header · required

API key must be provided in the Authorization header

Query Parameters

select_filters · string

JSON-encoded filter object. Format: {"field": {"op": value}}. Example: {"use_ssh": {"eq": true}, "recommended": {"eq": true}} or {"count_created": {"gt": 100}}

select_cols · string

JSON-encoded array of columns to return. Example: ["*"] for all columns or ["id", "name", "hash_id"] for specific columns.

order_by · string

Column to order the results by.

Response

200

application/json

Successfully retrieved templates

success · boolean · required

Example:

true

templates_found · integer · required

Number of templates found.

Example:

5

templates · object[] · required

List of templates matching the search criteria.

Show child attributes