Get VM network information

Retrieve detailed network configuration for a specific virtual server. It returns information about network interfaces, IP addresses (both IPv4 and IPv6), and available IP addresses that can be assigned. The information is necessary to understand and manage the server's network connection, and a `requestId` is returned that can be used to track the operation in other systems.

Path Parameters

vmid integer · min: 1 required Example

Unique vmid identifier

Headers

Accept Example
Content-Type Example

Responses

200
success boolean
timestamp string
requestId string
data object
401
error string
message string
code string
timestamp string
requestId string
429
error string
message string
retryAfter string
requestId string
504
error string
message string
code string
timestamp string
requestId string
GET https://cloud.hostup.se/api/vm/{vmid}/network
For AI assistants
cURL 
curl -X GET "https://cloud.hostup.se/api/vm/5344/network" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"
Response 
{
  "success": true,
  "timestamp": "string",
  "requestId": "string",
  "data": {
    "interfaces": [
      {
        "id": "string",
        "name": "string",
        "model": "string",
        "mac": "string",
        "firewall": "string",
        "ip": [
          {
            "id": 0,
            "vmid": 0,
            "interface": 0,
            "ipaddress": "string",
            "mac": "string",
            "wanip": "string",
            "ip": "string",
            "mask": "string",
            "network": "string",
            "gateway": "string",
            "main": 0,
            "options": {
              "private": true,
              "keep_mac": true
            },
            "server_id": 0,
            "type": "string",
            "vlan": "string",
            "private": "string",
            "revdns": "string"
          }
        ],
        "bridge": "string",
        "vlan": "string",
        "link_down": "string"
      }
    ],
    "availableIPv4": [
      {
        "id": "string",
        "ipaddress": "string",
        "server_id": "string",
        "vlan": "string",
        "status": "string",
        "allocationStatus": "string",
        "isAvailable": true,
        "subnet_id": "string",
        "subnet_name": "string",
        "description": "string",
        "revdns": "string"
      }
    ],
    "availableIPv6": [
      {
        "id": "string",
        "ipaddress": "string",
        "server_id": "string",
        "vlan": "string",
        "status": "string",
        "allocationStatus": "string",
        "isAvailable": true,
        "subnet_id": "string",
        "subnet_name": "string",
        "description": "string",
        "revdns": "string"
      }
    ],
    "ipv4Limit": 0,
    "ipv6Limit": 0,
    "primaryIP": "string",
    "primaryIPrDNS": "string",
    "vlanTag": "string",
    "allowedIPv4Blocks": [
      "string"
    ],
    "allowedIPv6Blocks": [
      "string"
    ],
    "ipv6UpgradeOption": {
      "configId": "string",
      "name": "string",
      "variable": "string",
      "min": 0,
      "max": 0,
      "step": 0,
      "monthlyPrice": 0,
      "currentValue": 0
    },
    "privateNetworks": [
      {
        "allocationId": 0,
        "parentCidr": "string",
        "rackId": "string",
        "status": "string",
        "subnets": [
          {
            "id": "string",
            "cidr": "string",
            "vlanId": 0,
            "gateway": "string",
            "status": "string",
            "allocationId": 0,
            "hostbill": {
              "name": "string",
              "description": "string",
              "assignedIps": 0,
              "totalIps": 0
            }
          }
        ]
      }
    ],
    "privateNetworkDefaults": {
      "rackId": "string",
      "vlanRange": {
        "min": 0,
        "max": 0
      }
    },
    "ipChangePolicy": {
      "monthlyLimit": 0,
      "usedThisPeriod": 0,
      "remaining": 0,
      "periodStart": "string",
      "nextReset": "string",
      "lastUsedAt": "string"
    }
  }
}