Retrieve detailed information about a specific virtual server (VPS) based on its ID. This is useful for viewing specifications, status, usage, or billing information for an individual VPS. It returns an `order_id` that can be used to activate an order via POST /api/account/activate-order.
/instance/[id] path.vmid order_id → data.order_id product_id → data.product_id vmid integer · min: 1 required
Example: 10000 Unique vmid identifier
Accept Example Content-Type Example data object required data.backups integer required
· Example: 7 data.bandwidth_limit integer required
· Example: 2048 data.bandwidth_usage object required data.bandwidth_usage.data_received number required
· Example: 83.146078003 data.bandwidth_usage.data_sent number required
· Example: 74.394385864 data.billingcycle string · enum required
· Example: Monthly Annually Monthly data.cpu integer required
· Example: 2 data.created string · enum required
· Example: 2025-02-14 2025-02-14 2025-12-03 2025-12-08 data.details object required Optional validation details (field-level errors).
data.details.password string required
· Example: YOUR_PASSWORD data.details.rootpassword string required
· Example: YOUR_PASSWORD data.details.username string required
· Example: root data.disk integer required
· Example: 50 data.firstpayment integer required
· Example: 39 data.hostname string required
· Example: example.com data.id string required
· Example: 10415 data.ip_addresses array<string> required
· Example: ["192.0.0.1"] data.ipv4 string required
· Example: 192.0.0.1 data.ipv6 string required
· Example: data.next_due string · enum required
· Example: 2026-02-14 2026-02-08 2026-02-14 2026-03-08 2026-12-08 data.node string · enum required
· Example: stockholm1-23-vm 5950x-hz-2 pve-5 stockholm1-23-vm data.order_id string required
· Example: 18378 data.os string · enum required
· Example: Ubuntu 22.04 Ubuntu 22.04 Ubuntu 24.04 Windows Server 2019 (BYOL) data.price integer required
· Example: 39 data.pricing object required data.pricing.addons array<object> required
· Example: [] data.pricing.addonsAnnualCost integer required
· Example: 0 data.pricing.addonsMonthlyCost integer required
· Example: 0 data.pricing.baseAnnualCost integer required
· Example: 468 data.pricing.baseMonthlyCost integer required
· Example: 39 data.pricing.billingCycle object required data.pricing.billingCycle.id string required
· Example: monthly data.pricing.billingCycle.isFree boolean required
· Example: false data.pricing.billingCycle.months integer required
· Example: 1 data.pricing.billingCycle.raw string · enum required
· Example: monthly annually monthly data.pricing.currency string required
· Example: SEK data.pricing.pricePerCycle integer required
· Example: 39 data.pricing.totalAnnualCost integer required
· Example: 468 data.pricing.totalMonthlyCost integer required
· Example: 39 data.product_id string required
· Example: 1932 data.product_name string required
· Example: VPS XS data.ram number required
· Example: 4 data.status string required
· Example: Active data.total integer required
· Example: 39 data.uptime integer required
· Example: 1404875 data.usage_log object required data.vm_status string · enum required
· Example: running running stopped 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).
https://cloud.hostup.se/api/vm/{vmid}/details curl -X GET "https://cloud.hostup.se/api/vm/10000/details" \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" {
"success": true,
"timestamp": "2026-02-10T00:00:00.000Z",
"requestId": "2121ae20-bd9d-41e9-aeeb-5dd1dd1a24ba",
"data": {
"id": "10415",
"product_id": "1932",
"product_name": "VPS XS",
"hostname": "example.com",
"status": "Active",
"created": "2025-02-14",
"order_id": "18378",
"billingcycle": "Monthly",
"price": 39,
"total": 39,
"firstpayment": 39,
"next_due": "2026-02-14",
"cpu": 2,
"ram": 4,
"disk": 50,
"bandwidth_limit": 2048,
"bandwidth_usage": {
"data_received": 83.146078003,
"data_sent": 74.394385864
},
"usage_log": {
"2026-02-10T00:00:00.000Z": {
"data_received": 83.14607800299991,
"data_sent": 74.39438586399984,
"mem_unit": 1024,
"probes": 1,
"time": 0.008611111111111111,
"uptime": 0.008611111111111111,
"maxcpu": 0.017222222222222222,
"maxcpu_on": 0.017222222222222222,
"cpu": 0.0007352018071116705,
"maxmem": 0.034444444444444444,
"maxmem_on": 0.034444444444444444,
"mem": 0.02599885834587945,
"maxdisk": 0.4305555555555556,
"template": 0,
"ipv4_addresses": 0.008611111111111111
}
},
"backups": 7,
"ip_addresses": [
"192.0.0.1"
],
"ipv4": "192.0.0.1",
"ipv6": "",
"os": "Ubuntu 22.04",
"node": "stockholm1-23-vm",
"uptime": 1404875,
"vm_status": "running",
"details": {
"username": "root",
"password": "YOUR_PASSWORD",
"rootpassword": "YOUR_PASSWORD"
},
"pricing": {
"currency": "SEK",
"billingCycle": {
"id": "monthly",
"months": 1,
"raw": "monthly",
"isFree": false
},
"pricePerCycle": 39,
"baseMonthlyCost": 39,
"baseAnnualCost": 468,
"addonsMonthlyCost": 0,
"addonsAnnualCost": 0,
"totalMonthlyCost": 39,
"totalAnnualCost": 468,
"addons": []
}
}
}