List Templates

Search and list templates using optional query and filter parameters; returns public templates and the authenticated user’s own private templates.

GET /api/v0/template/

List 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,
  "msg": "<string>",
  "templates_found": 123,
  "templates": [
    {}
  ]
}

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

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

Returns {success, templates_found, templates} on success, or {success: false, msg: "No templates found"} when no results match

success · boolean

True if templates were found, false otherwise

msg · string

Present when no templates are found: "No templates found"

templates_found · integer

Count of returned templates

templates · object[]

Array of matching template objects