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
}
'

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