Get a VM template

GET

/vm/templates/{templateId}

curl --request GET \
  --url https://sylve.lan:8181/api/vm/templates/1 \
  --header 'Authorization: <Authorization>'

Retrieve a VM template by its template ID

Authorizations

• BearerAuth

Parameters

Path Parameters

templateId

required

integer

>= 1

VM Template ID

Responses

200

Success

Media typeapplication/json

object

data

object

acpi

boolean

apic

boolean

bootRom

string

Allowed values: uefi uboot none

cloudInitData

string

cloudInitMetaData

string

cloudInitNetworkConfig

string

cpuCores

integer

cpuSockets

integer

cpuThreads

integer

createdAt

string

description

string

extraBhyveOptions

Array<string>

id

integer

ignoreUMSR

boolean

name

string

networks

Array<object>

object

emulation

string

name

string

switchName

string

switchType

string

qemuGuestAgent

boolean

ram

integer

serial

boolean

shutdownWaitTime

integer

sourceVmName

string

sourceVmRid

integer

startAtBoot

boolean

startOrder

integer

storages

Array<object>

object

bootOrder

integer

emulation

string

Allowed values: virtio-blk virtio-9p ahci-hd ahci-cd nvme

enable

boolean

estimatedBytes

integer

pool

string

recordSize

integer

size

integer

sourceStorageId

integer

templateDataset

string

type

string

Allowed values: raw zvol image filesystem

volBlockSize

integer

timeOffset

string

Allowed values: utc localtime

tpmEmulation

boolean

updatedAt

string

vncBind

string

vncEnabled

boolean

vncResolution

string

vncWait

boolean

wol

boolean

error

string

message

string

status

string

Example

{
  "data": {
    "bootRom": "uefi",
    "storages": [
      {
        "emulation": "virtio-blk",
        "type": "raw"
      }
    ],
    "timeOffset": "utc"
  }
}

400

Bad Request

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Unauthorized

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

404

Not Found

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Internal Server Error

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}