Get a Virtual Machine by RID

GET

/vm/{rid}

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

Retrieve a virtual machine by its resource ID (RID)

Authorizations

• BearerAuth

Parameters

Path Parameters

rid

required

integer

>= 1

Virtual Machine RID

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

cpuPinning

Array<object>

object

hostCpu

Array<integer>

hostSocket

integer

id

integer

vmId

integer

cpuSockets

integer

cpuThreads

integer

createdAt

string

description

string

extraBhyveOptions

Array<string>

id

integer

ignoreUMSR

boolean

intentionallyStopped

boolean

name

string

networks

Array<object>

object

emulation

string

enable

boolean

id

integer

mac

string

macId

integer

macObj

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

id

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

id

integer

isUsed

boolean

isUsedBy

“”, “dhcp” for now

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

id

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

manualSwitch

object

bridge

string

createdAt

string

id

integer

name

string

updatedAt

string

standardSwitch

object

address

string

address6

string

address6Id

integer

address6Obj

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

id

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

id

integer

isUsed

boolean

isUsedBy

“”, “dhcp” for now

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

id

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

addressId

integer

addressObj

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

id

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

id

integer

isUsed

boolean

isUsedBy

“”, “dhcp” for now

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

id

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

bridgeMacMode

string

bridgeMacObject

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

id

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

id

integer

isUsed

boolean

isUsedBy

“”, “dhcp” for now

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

id

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

bridgeMacObjectId

integer

bridgeMacSourcePort

string

bridgeName

string

createdAt

string

defaultRoute

DefaultRoute owns the IPv4 default route for static or DHCP addressing.

boolean

defaultRoute6

DefaultRoute6 owns the IPv6 default route for static or SLAAC addressing.

boolean

dhcp

boolean

disableBridgeOffloads

DisableBridgeOffloads keeps FreeBSD from changing bridge-member capabilities as transient tap and epair interfaces come and go. Sorts flapping issues (Please tell @hayzam if you faced flapping before/after enabling this option).

boolean

disableIPv6

boolean

gateway6AddressId

integer

gateway6AddressObj

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

id

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

id

integer

isUsed

boolean

isUsedBy

“”, “dhcp” for now

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

id

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

gateway6Manual

string

gatewayAddressId

integer

gatewayAddressObj

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

id

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

id

integer

isUsed

boolean

isUsedBy

“”, “dhcp” for now

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

id

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

gatewayManual

string

id

integer

mtu

integer

name

string

network6Id

integer

network6Manual

string

network6Obj

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

id

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

id

integer

isUsed

boolean

isUsedBy

“”, “dhcp” for now

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

id

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

networkId

integer

networkManual

string

networkObj

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

id

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

id

integer

isUsed

boolean

isUsedBy

“”, “dhcp” for now

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

id

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

ports

Array<object>

object

id

integer

name

string

switch

object recursive

switchId

integer

private

boolean

slaac

boolean

updatedAt

string

vlan

integer

switchId

integer

switchType

string

vmId

integer

pciDevices

Array<integer>

qemuGuestAgent

boolean

ram

integer

rid

integer

serial

boolean

shutdownWaitTime

integer

snapshots

Array<object>

object

createdAt

string

description

string

id

integer

name

string

parentSnapshotId

integer

rid

integer

rootDatasets

Array<string>

snapshotName

string

updatedAt

string

vmId

integer

startAtBoot

boolean

startOrder

integer

startedAt

string

state

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7

stoppedAt

string

storages

Array<object>

object

bootOrder

integer

dataset

object

guid

string

id

integer

name

string

pool

string

datasetId

integer

emulation

string

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

enable

boolean

filesystemTarget

string

id

integer

name

string

pool

string

readOnly

boolean

recordSize

integer

size

integer

type

string

Allowed values: raw zvol image filesystem

uuid

string

vmId

integer

volBlockSize

integer

timeOffset

string

Allowed values: utc localtime

tpmEmulation

boolean

updatedAt

string

vncBind

string

vncEnabled

boolean

vncPassword

string

vncPort

integer

vncResolution

string

vncWait

boolean

wol

boolean

error

string

message

string

status

string

Example

{
  "data": {
    "bootRom": "uefi",
    "state": 0,
    "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"
}