Get detailed status information for a virtual server

Retrieve the current status and detailed configuration for your virtual server (VM). This information is important for monitoring the server's state, especially during processes like reinstallation or password resets. The endpoint returns a `server_id` that can be used to call `POST /api/server-tags`.

VPS Services VM

Context

Where to get IDs / values

Workflow links

Produces

Path Parameters

vmid integer · min: 1 required Example: 10000

Unique vmid identifier

Headers

Accept Example
Content-Type Example

Responses

200
data object required
data.vm object required
data.vm.additional_storage array<object> required · Example: []
data.vm.bandwidth object required
data.vm.bandwidth.data_received integer required · Example: 642739744886
data.vm.bandwidth.data_sent integer required · Example: 314381446126
data.vm.built boolean required · Example: true
data.vm.cloudinit boolean required · Example: true
data.vm.cores integer required · Example: 4
data.vm.cpu integer required · Example: 4
data.vm.disk integer required · Example: 200
data.vm.fullid string required · Example: qemu/10564
data.vm.ha boolean required · Example: true
data.vm.hostname string required · Example: example.com
data.vm.id integer required · Example: 10564
data.vm.interfaces object required
data.vm.interfaces.net0 object required
data.vm.interfaces.net0.bridge string required · Example: vmbr0
data.vm.interfaces.net0.firewall string required · Example: 1
data.vm.interfaces.net0.id integer required · Example: 0
data.vm.interfaces.net0.ip array<object> required · Example: [{"id":11056,"vmid":10000,"interface":0,"ipaddress":"2001:db8::1","mac":"00:00:00:00:00...
data.vm.interfaces.net0.ip[].gateway string · enum required · Example: 2001:db8::1
2001:db8::1
2001:db8::1
192.0.0.1
192.0.0.1
192.0.0.1
data.vm.interfaces.net0.ip[].id integer required · Example: 11056
data.vm.interfaces.net0.ip[].interface integer required · Example: 0
data.vm.interfaces.net0.ip[].ip string required · Example: 2001:db8::1
data.vm.interfaces.net0.ip[].ipaddress string required · Example: 2001:db8::1
data.vm.interfaces.net0.ip[].mac string · enum required · Example: 00:00:00:00:00:00
00:00:00:00:00:00
00:00:00:00:00:00
00:00:00:00:00:00
data.vm.interfaces.net0.ip[].main integer required · Example: 1
data.vm.interfaces.net0.ip[].mask string required · Example: /56
data.vm.interfaces.net0.ip[].network string · enum required · Example: 2001:db8::1/56
2001:db8::1/48
2001:db8::1/56
192.0.0.1/25
192.0.0.1/25
192.0.0.1/24
data.vm.interfaces.net0.ip[].options object required
data.vm.interfaces.net0.ip[].options.keep_mac boolean required · Example: false
data.vm.interfaces.net0.ip[].options.private boolean required · Example: false
data.vm.interfaces.net0.ip[].private string required · Example: 0
data.vm.interfaces.net0.ip[].server_id integer required · Example: 811
data.vm.interfaces.net0.ip[].type string · enum required · Example: ipv6
ipv4
ipv6
data.vm.interfaces.net0.ip[].vlan string required · Example: 103
data.vm.interfaces.net0.ip[].vmid integer required · Example: 10000
data.vm.interfaces.net0.ip[].wanip string required · Example:
data.vm.interfaces.net0.link_down string required · Example:
data.vm.interfaces.net0.mac string · enum required · Example: 00:00:00:00:00:00
00:00:00:00:00:00
00:00:00:00:00:00
00:00:00:00:00:00
data.vm.interfaces.net0.model string required · Example: virtio
data.vm.interfaces.net0.name string required · Example: net0
data.vm.interfaces.net0.vlan string | boolean required · Example: 103
data.vm.ipam array<object> required · Example: [{"id":11056,"vmid":10000,"interface":0,"ipaddress":"2001:db8::1","mac":"00:00:00:00:00...
data.vm.ipam[].gateway string · enum required · Example: 2001:db8::1
2001:db8::1
2001:db8::1
192.0.0.1
192.0.0.1
192.0.0.1
data.vm.ipam[].id integer required · Example: 11056
data.vm.ipam[].interface integer required · Example: 0
data.vm.ipam[].ip string required · Example: 2001:db8::1
data.vm.ipam[].ipaddress string required · Example: 2001:db8::1
data.vm.ipam[].mac string · enum required · Example: 00:00:00:00:00:00
00:00:00:00:00:00
00:00:00:00:00:00
00:00:00:00:00:00
data.vm.ipam[].main integer required · Example: 1
data.vm.ipam[].mask string required · Example: /56
data.vm.ipam[].network string · enum required · Example: 2001:db8::1/56
2001:db8::1/48
2001:db8::1/56
192.0.0.1/25
192.0.0.1/25
192.0.0.1/24
data.vm.ipam[].options object required
data.vm.ipam[].options.keep_mac boolean required · Example: false
data.vm.ipam[].options.private boolean required · Example: false
data.vm.ipam[].private string required · Example: 0
data.vm.ipam[].server_id integer required · Example: 811
data.vm.ipam[].type string · enum required · Example: ipv6
ipv4
ipv6
data.vm.ipam[].vlan string required · Example: 103
data.vm.ipam[].vmid integer required · Example: 10000
data.vm.ipam[].wanip string required · Example:
data.vm.ipv4 string required · Example: 192.0.0.1
data.vm.ipv6 string required · Example: 2001:db8::1
data.vm.locked boolean required · Example: false
data.vm.mac string · enum required · Example: 00:00:00:00:00:00
00:00:00:00:00:00
00:00:00:00:00:00
00:00:00:00:00:00
data.vm.memory string required · Example: 16384
data.vm.node string · enum required · Example: pve-1
pve-1
pve-4
stockholm1-06-vm
data.vm.org_template_data array<object> required · Example: []
data.vm.password string required · Example: YOUR_PASSWORD
data.vm.pending_reboot string required · Example:
data.vm.power boolean required · Example: true
data.vm.replication boolean required · Example: false
data.vm.sockets integer required · Example: 1
data.vm.sshkeys array<string> required · Example: ["ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIEVYQU1QTEVfU1NIX0tFWV9EQVRBX09OTFk example@hostup"]
data.vm.status string · enum required · Example: running
reset
running
stopped
data.vm.status_lang string · enum required · Example: vm_state_running
vm_state_reset
vm_state_running
vm_state_stopped
data.vm.storage array<object> required · Example: [{"zone":"block-storage-vm","storage":"block-storage-vm","configline":"block-storage-vm...
data.vm.storage[].boot_order integer required · Example: 0
data.vm.storage[].bootable boolean required · Example: true
data.vm.storage[].cdrom boolean required · Example: false
data.vm.storage[].cloudinit boolean required · Example: false
data.vm.storage[].configline string required · Example: block-storage-vm:vm-10564-disk-0,discard=on,iothread=1,mbps_rd=500,mbps_wr=500,size=200...
data.vm.storage[].format string required · Example: raw
data.vm.storage[].is_disk boolean required · Example: true
data.vm.storage[].locked boolean required · Example: true
data.vm.storage[].mp string required · Example: /
data.vm.storage[].name string required · Example: scsi0
data.vm.storage[].profile_id string required · Example: default
data.vm.storage[].size integer required · Example: 214748364800
data.vm.storage[].size_gb integer required · Example: 200
data.vm.storage[].storage string required · Example: block-storage-vm
data.vm.storage[].type string required · Example: scsi
data.vm.storage[].volid string required · Example: block-storage-vm:vm-10564-disk-0
data.vm.storage[].zone string required · Example: block-storage-vm
data.vm.swap string required · Example:
data.vm.tags array<string> required · Example: [""]
data.vm.template_data array<object> required · Example: []
data.vm.template_id string required · Example: block-storage-vm:102/base-102-disk-1
data.vm.template_name string required · Example: Ubuntu 24.04
data.vm.uptime integer required · Example: 8
data.vm.username string required · Example: root
data.vm.virt string required · Example: qemu
requestId string required · Example: 2121ae20-bd9d-41e9-aeeb-5dd1dd1a24ba

Unique request identifier (UUID).

success boolean required · Example: true

True for successful responses.

timestamp string required · Example: 2026-02-10T00:00:00.000Z

ISO 8601 timestamp (UTC).

GET https://cloud.hostup.se/api/vm/{vmid}/details-poll
For AI assistants
cURL 
curl -X GET "https://cloud.hostup.se/api/vm/10000/details-poll" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"
Response 
{
  "success": true,
  "timestamp": "2026-02-10T00:00:00.000Z",
  "requestId": "2121ae20-bd9d-41e9-aeeb-5dd1dd1a24ba",
  "data": {
    "vm": {
      "id": 10564,
      "fullid": "qemu/10564",
      "node": "pve-1",
      "hostname": "example.com",
      "virt": "qemu",
      "ha": true,
      "built": true,
      "locked": false,
      "power": true,
      "status": "running",
      "status_lang": "vm_state_running",
      "password": "YOUR_PASSWORD",
      "sshkeys": [
        "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIEVYQU1QTEVfU1NIX0tFWV9EQVRBX09OTFk example@hostup"
      ],
      "username": "root",
      "cpu": 4,
      "memory": "16384",
      "disk": 200,
      "swap": "",
      "additional_storage": [],
      "uptime": 8,
      "ipam": [
        {
          "id": 11056,
          "vmid": 10000,
          "interface": 0,
          "ipaddress": "2001:db8::1",
          "mac": "00:00:00:00:00:00",
          "wanip": "",
          "ip": "2001:db8::1",
          "mask": "/56",
          "network": "2001:db8::1/56",
          "gateway": "2001:db8::1",
          "main": 1,
          "options": {
            "private": false,
            "keep_mac": false
          },
          "server_id": 811,
          "type": "ipv6",
          "vlan": "103",
          "private": "0"
        },
        {
          "id": 11637,
          "vmid": 10000,
          "interface": 0,
          "ipaddress": "192.0.0.1",
          "mac": "00:00:00:00:00:00",
          "wanip": "",
          "ip": "192.0.0.1",
          "mask": "/25",
          "network": "192.0.0.1/25",
          "gateway": "192.0.0.1",
          "main": 1,
          "options": {
            "private": false,
            "keep_mac": false
          },
          "server_id": 815,
          "type": "ipv4",
          "vlan": "103",
          "private": "0"
        }
      ],
      "template_id": "block-storage-vm:102/base-102-disk-1",
      "template_name": "Ubuntu 24.04",
      "template_data": [],
      "replication": false,
      "cloudinit": true,
      "pending_reboot": "",
      "tags": [
        ""
      ],
      "ipv4": "192.0.0.1",
      "ipv6": "2001:db8::1",
      "org_template_data": [],
      "bandwidth": {
        "data_received": 642739744886,
        "data_sent": 314381446126
      },
      "storage": [
        {
          "zone": "block-storage-vm",
          "storage": "block-storage-vm",
          "configline": "block-storage-vm:vm-10564-disk-0,discard=on,iothread=1,mbps_rd=500,mbps_wr=500,size=200G,ssd=1",
          "volid": "block-storage-vm:vm-10564-disk-0",
          "cdrom": false,
          "cloudinit": false,
          "is_disk": true,
          "size": 214748364800,
          "size_gb": 200,
          "mp": "/",
          "format": "raw",
          "bootable": true,
          "boot_order": 0,
          "name": "scsi0",
          "type": "scsi",
          "locked": true,
          "profile_id": "default"
        }
      ],
      "cores": 4,
      "sockets": 1,
      "interfaces": {
        "net0": {
          "id": 0,
          "name": "net0",
          "model": "virtio",
          "mac": "00:00:00:00:00:00",
          "firewall": "1",
          "ip": [
            {
              "id": 11056,
              "vmid": 10000,
              "interface": 0,
              "ipaddress": "2001:db8::1",
              "mac": "00:00:00:00:00:00",
              "wanip": "",
              "ip": "2001:db8::1",
              "mask": "/56",
              "network": "2001:db8::1/56",
              "gateway": "2001:db8::1",
              "main": 1,
              "options": {
                "private": false,
                "keep_mac": false
              },
              "server_id": 811,
              "type": "ipv6",
              "vlan": "103",
              "private": "0"
            },
            {
              "id": 11637,
              "vmid": 10000,
              "interface": 0,
              "ipaddress": "192.0.0.1",
              "mac": "00:00:00:00:00:00",
              "wanip": "",
              "ip": "192.0.0.1",
              "mask": "/25",
              "network": "192.0.0.1/25",
              "gateway": "192.0.0.1",
              "main": 1,
              "options": {
                "private": false,
                "keep_mac": false
              },
              "server_id": 815,
              "type": "ipv4",
              "vlan": "103",
              "private": "0"
            }
          ],
          "bridge": "vmbr0",
          "vlan": "103",
          "link_down": ""
        }
      },
      "mac": "00:00:00:00:00:00"
    }
  }
}