edit template

Edits an existing template in place.

Templates are mutable. Use PUT with the template’s hash_id to update it. You only need to include the fields you want to change - unchanged fields retain their existing values.

Note: The template’s hash_id will change after editing (since it’s content-based), but the numeric id stays the same.

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

CLI Usage: vastai update template <hash_id> [options]

PUT /api/v0/template

edit template

cURL

curl --request PUT \
  --url https://console.vast.ai/api/v0/template \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "hash_id": "5915f1dc1ce881defb572015eb9d8178",
  "desc": "Updated description",
  "recommended_disk_space": 16
}
'

import requests

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

payload = {
    "hash_id": "5915f1dc1ce881defb572015eb9d8178",
    "desc": "Updated description",
    "recommended_disk_space": 16
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    hash_id: '5915f1dc1ce881defb572015eb9d8178',
    desc: 'Updated description',
    recommended_disk_space: 16
  })
};

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 => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'hash_id' => '5915f1dc1ce881defb572015eb9d8178',
    'desc' => 'Updated description',
    'recommended_disk_space' => 16
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"hash_id\": \"5915f1dc1ce881defb572015eb9d8178\",\n  \"desc\": \"Updated description\",\n  \"recommended_disk_space\": 16\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://console.vast.ai/api/v0/template")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"hash_id\": \"5915f1dc1ce881defb572015eb9d8178\",\n  \"desc\": \"Updated description\",\n  \"recommended_disk_space\": 16\n}")
  .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::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"hash_id\": \"5915f1dc1ce881defb572015eb9d8178\",\n  \"desc\": \"Updated description\",\n  \"recommended_disk_space\": 16\n}"

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

200

{
  "success": true,
  "template": {
    "id": 123,
    "hash_id": "<string>"
  }
}

Authorizations

Authorization · string · header · required

API key must be provided in the Authorization header

Body

application/json

hash_id · string · required

Hash ID of the template to edit. Required for identifying which template to update.

name · string

Name of the template

image · string

Docker image path

desc · string

Short description of the template

recommended_disk_space · number

Recommended disk space in GB

Response

200

application/json

Template updated successfully

success · boolean

template · object

Show child attributes