---
title: "Get a Virtual Machine by RID or ID"
method: GET
path: "/vm/:id"
tags: ["VM"]
---

# Get a Virtual Machine by RID or ID

`GET /vm/:id`

Retrieve a virtual machine by its RID or ID

## Path parameters

- `rid` string, required

## Query parameters

- `type` 'rid' | 'id'

## Response `200`

Success

- GithubComAlchemillahqSylveInternalAPIResponseGithubComAlchemillahqSylveInternalDbModelsVmVM
  - `data` GithubComAlchemillahqSylveInternalDbModelsVmVM
    - `acpi` boolean
    - `apic` boolean
    - `bootRom` 'uefi' | 'none'
    - `cloudInitData` string
    - `cloudInitMetaData` string
    - `cloudInitNetworkConfig` string
    - `cpuCores` integer
    - `cpuPinning` GithubComAlchemillahqSylveInternalDbModelsVmVMCPUPinning[]
      - `hostCpu` integer[]
      - `hostSocket` integer
      - `id` integer
      - `vmId` integer
    - `cpuSockets` integer
    - `cpuThreads` integer
    - `createdAt` string
    - `description` string
    - `extraBhyveOptions` string[]
    - `id` integer
    - `ignoreUMSR` boolean
    - `name` string
    - `networks` GithubComAlchemillahqSylveInternalDbModelsVmNetwork[]
      - `emulation` string
      - `id` integer
      - `mac` string
      - `macId` integer
      - `macObj` GithubComAlchemillahqSylveInternalDbModelsNetworkObject
        - `autoUpdate` boolean
        - `createdAt` string
        - `description` string
        - `entries` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectEntry[]
          - `createdAt` string
          - `id` integer
          - `objectId` integer
          - `updatedAt` string
          - `value` string — IP, CIDR, port, country code, FQDN, etc.
        - `id` integer
        - `isUsed` boolean
        - `isUsedBy` string — "", "dhcp" for now
        - `lastRefreshAt` string
        - `lastRefreshError` string
        - `name` string
        - `refreshIntervalSeconds` integer
        - `resolutionChecksum` string
        - `resolutions` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectResolution[]
          - `createdAt` string
          - `id` integer
          - `objectId` integer
          - `resolvedIp` string — deprecated mirror for resolved IP entries
          - `resolvedValue` string
          - `updatedAt` string
        - `sourceChecksum` string
        - `type` string — "Host", "Mac", "Network", "Port", "Country", "List", "FQDN", "DUID"
        - `updatedAt` string
      - `manualSwitch` GithubComAlchemillahqSylveInternalDbModelsNetworkManualSwitch
        - `bridge` string
        - `createdAt` string
        - `id` integer
        - `name` string
        - `updatedAt` string
      - `standardSwitch` GithubComAlchemillahqSylveInternalDbModelsNetworkStandardSwitch
        - `address` string
        - `address6` string
        - `address6Id` integer
        - `address6Obj` GithubComAlchemillahqSylveInternalDbModelsNetworkObject
          - `autoUpdate` boolean
          - `createdAt` string
          - `description` string
          - `entries` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectEntry[]
            - `createdAt` string
            - `id` integer
            - `objectId` integer
            - `updatedAt` string
            - `value` string — IP, CIDR, port, country code, FQDN, etc.
          - `id` integer
          - `isUsed` boolean
          - `isUsedBy` string — "", "dhcp" for now
          - `lastRefreshAt` string
          - `lastRefreshError` string
          - `name` string
          - `refreshIntervalSeconds` integer
          - `resolutionChecksum` string
          - `resolutions` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectResolution[]
            - `createdAt` string
            - `id` integer
            - `objectId` integer
            - `resolvedIp` string — deprecated mirror for resolved IP entries
            - `resolvedValue` string
            - `updatedAt` string
          - `sourceChecksum` string
          - `type` string — "Host", "Mac", "Network", "Port", "Country", "List", "FQDN", "DUID"
          - `updatedAt` string
        - `addressId` integer
        - `addressObj` GithubComAlchemillahqSylveInternalDbModelsNetworkObject
          - `autoUpdate` boolean
          - `createdAt` string
          - `description` string
          - `entries` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectEntry[]
            - `createdAt` string
            - `id` integer
            - `objectId` integer
            - `updatedAt` string
            - `value` string — IP, CIDR, port, country code, FQDN, etc.
          - `id` integer
          - `isUsed` boolean
          - `isUsedBy` string — "", "dhcp" for now
          - `lastRefreshAt` string
          - `lastRefreshError` string
          - `name` string
          - `refreshIntervalSeconds` integer
          - `resolutionChecksum` string
          - `resolutions` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectResolution[]
            - `createdAt` string
            - `id` integer
            - `objectId` integer
            - `resolvedIp` string — deprecated mirror for resolved IP entries
            - `resolvedValue` string
            - `updatedAt` string
          - `sourceChecksum` string
          - `type` string — "Host", "Mac", "Network", "Port", "Country", "List", "FQDN", "DUID"
          - `updatedAt` string
        - `bridgeName` string
        - `createdAt` string
        - `defaultRoute` boolean
        - `dhcp` boolean
        - `disableIPv6` boolean
        - `gateway6AddressId` integer
        - `gateway6AddressObj` GithubComAlchemillahqSylveInternalDbModelsNetworkObject
          - `autoUpdate` boolean
          - `createdAt` string
          - `description` string
          - `entries` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectEntry[]
            - `createdAt` string
            - `id` integer
            - `objectId` integer
            - `updatedAt` string
            - `value` string — IP, CIDR, port, country code, FQDN, etc.
          - `id` integer
          - `isUsed` boolean
          - `isUsedBy` string — "", "dhcp" for now
          - `lastRefreshAt` string
          - `lastRefreshError` string
          - `name` string
          - `refreshIntervalSeconds` integer
          - `resolutionChecksum` string
          - `resolutions` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectResolution[]
            - `createdAt` string
            - `id` integer
            - `objectId` integer
            - `resolvedIp` string — deprecated mirror for resolved IP entries
            - `resolvedValue` string
            - `updatedAt` string
          - `sourceChecksum` string
          - `type` string — "Host", "Mac", "Network", "Port", "Country", "List", "FQDN", "DUID"
          - `updatedAt` string
        - `gatewayAddressId` integer
        - `gatewayAddressObj` GithubComAlchemillahqSylveInternalDbModelsNetworkObject
          - `autoUpdate` boolean
          - `createdAt` string
          - `description` string
          - `entries` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectEntry[]
            - `createdAt` string
            - `id` integer
            - `objectId` integer
            - `updatedAt` string
            - `value` string — IP, CIDR, port, country code, FQDN, etc.
          - `id` integer
          - `isUsed` boolean
          - `isUsedBy` string — "", "dhcp" for now
          - `lastRefreshAt` string
          - `lastRefreshError` string
          - `name` string
          - `refreshIntervalSeconds` integer
          - `resolutionChecksum` string
          - `resolutions` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectResolution[]
            - `createdAt` string
            - `id` integer
            - `objectId` integer
            - `resolvedIp` string — deprecated mirror for resolved IP entries
            - `resolvedValue` string
            - `updatedAt` string
          - `sourceChecksum` string
          - `type` string — "Host", "Mac", "Network", "Port", "Country", "List", "FQDN", "DUID"
          - `updatedAt` string
        - `id` integer
        - `mtu` integer
        - `name` string
        - `network6Id` integer
        - `network6Obj` GithubComAlchemillahqSylveInternalDbModelsNetworkObject
          - `autoUpdate` boolean
          - `createdAt` string
          - `description` string
          - `entries` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectEntry[]
            - `createdAt` string
            - `id` integer
            - `objectId` integer
            - `updatedAt` string
            - `value` string — IP, CIDR, port, country code, FQDN, etc.
          - `id` integer
          - `isUsed` boolean
          - `isUsedBy` string — "", "dhcp" for now
          - `lastRefreshAt` string
          - `lastRefreshError` string
          - `name` string
          - `refreshIntervalSeconds` integer
          - `resolutionChecksum` string
          - `resolutions` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectResolution[]
            - `createdAt` string
            - `id` integer
            - `objectId` integer
            - `resolvedIp` string — deprecated mirror for resolved IP entries
            - `resolvedValue` string
            - `updatedAt` string
          - `sourceChecksum` string
          - `type` string — "Host", "Mac", "Network", "Port", "Country", "List", "FQDN", "DUID"
          - `updatedAt` string
        - `networkId` integer
        - `networkObj` GithubComAlchemillahqSylveInternalDbModelsNetworkObject
          - `autoUpdate` boolean
          - `createdAt` string
          - `description` string
          - `entries` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectEntry[]
            - `createdAt` string
            - `id` integer
            - `objectId` integer
            - `updatedAt` string
            - `value` string — IP, CIDR, port, country code, FQDN, etc.
          - `id` integer
          - `isUsed` boolean
          - `isUsedBy` string — "", "dhcp" for now
          - `lastRefreshAt` string
          - `lastRefreshError` string
          - `name` string
          - `refreshIntervalSeconds` integer
          - `resolutionChecksum` string
          - `resolutions` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectResolution[]
            - `createdAt` string
            - `id` integer
            - `objectId` integer
            - `resolvedIp` string — deprecated mirror for resolved IP entries
            - `resolvedValue` string
            - `updatedAt` string
          - `sourceChecksum` string
          - `type` string — "Host", "Mac", "Network", "Port", "Country", "List", "FQDN", "DUID"
          - `updatedAt` string
        - `ports` GithubComAlchemillahqSylveInternalDbModelsNetworkNetworkPort[]
          - `id` integer
          - `name` string
          - `switch` GithubComAlchemillahqSylveInternalDbModelsNetworkStandardSwitch — recursive
          - `switchId` integer
        - `private` boolean
        - `slaac` boolean
        - `updatedAt` string
        - `vlan` integer
      - `switchId` integer
      - `switchType` string
      - `vmId` integer
    - `pciDevices` integer[]
    - `qemuGuestAgent` boolean
    - `ram` integer
    - `rid` integer
    - `serial` boolean
    - `shutdownWaitTime` integer
    - `snapshots` GithubComAlchemillahqSylveInternalDbModelsVmVMSnapshot[]
      - `createdAt` string
      - `description` string
      - `id` integer
      - `name` string
      - `parentSnapshotId` integer
      - `rid` integer
      - `rootDatasets` string[]
      - `snapshotName` string
      - `updatedAt` string
      - `vmId` integer
    - `startAtBoot` boolean
    - `startOrder` integer
    - `startedAt` string
    - `state` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7
    - `stoppedAt` string
    - `storages` GithubComAlchemillahqSylveInternalDbModelsVmStorage[]
      - `bootOrder` integer
      - `dataset` GithubComAlchemillahqSylveInternalDbModelsVmVMStorageDataset
        - `guid` string
        - `id` integer
        - `name` string
        - `pool` string
      - `datasetId` integer
      - `emulation` '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` 'raw' | 'zvol' | 'image' | 'filesystem'
      - `uuid` string
      - `vmId` integer
      - `volBlockSize` integer
    - `timeOffset` '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

## Other responses

- `400` — Bad Request
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/alchemillahq/apis/sylve-api.md) · [All operations](https://skmtc.net/alchemillahq/apis/sylve-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/alchemillahq/sylve-api/versions/950e51f8af98/schema)