Get a VPS
GET /api/v2/vps/{id}
Get one VPS with its status, power state, primary IP, operating system, resources, price, bandwidth use and tags. It has the fields of GET /api/v2/vps and a few more. hardware is the host CPU and the CPU type the operating system sees. Action gates such as actions.canRestart are on GET /api/v2/vps/{id}/details.
billing.isPayg is true for a Cloud VPS. Its billing.amount is then null. A pending or suspended VPS also has overdueInvoices, the unpaid invoices for this server. An active VPS over its bandwidth allowance has its open bandwidth invoice there. A suspended, terminated or cancelled VPS has suspendedAt. A terminated or cancelled one also has terminatedAt and backupRetention, which says whether its backups are still stored and until when. scheduledChange is set while a downgrade or a switch to Cloud VPS waits for the next renewal. Until then billing shows the price of the running period.
Authentication: An API key with the scope read:services. About keys and scopes
Request
Path parameters
idstringrequiredvps_…).Example
curl "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3" \ -H "Authorization: Bearer $HOSTUP_API_KEY"Responses
200 The VPS.
{ "id": "vps_01hxa3b4c5d6e7f8g9h0j1k2m3", "name": "app-01", "primaryIp": "192.0.2.10", "serviceStatus": "active", "powerState": "running", "operatingSystem": { "displayName": "Ubuntu 24.04", "family": "ubuntu", "version": "24.04", "variant": null }, "customerMetadata": { "displayName": "Production DB", "operatingSystemName": "Ubuntu 24.04 with Docker", "operatingSystemSourceName": "Ubuntu 24.04", "updatedAt": "2026-06-30T10:00:00.000Z" }, "hardware": { "cpuModel": "AMD EPYC 7R13", "cpuVendor": "amd", "guestCpuModel": "EPYC-Rome-v5" }, "resources": { "cpuCores": 2, "memoryGb": 4, "storageGb": 80 }, "billing": { "amount": 99, "currencyCode": "SEK", "billingCycle": "monthly", "isPayg": false }, "bandwidth": { "usedGb": 12.5, "limitGb": 1000, "inboundGb": 4.2, "outboundGb": 8.3, "hasOverage": false }, "availability": { "available": true, "reason": null }, "tags": [ "production" ], "pinned": false, "createdAt": "2026-04-27T12:00:00.000Z", "expiresAt": "2026-05-27T00:00:00.000Z", "guestAgentSetupUntil": null, "scheduledChange": null, "diskThrottle": { "active": false, "limitedRead": false, "limitedWrite": false, "readDrpd": null, "writeDwpd": null, "diskSizeGb": null, "estimatedDailyReadGb": null, "estimatedDailyWriteGb": null, "totalReadLast7DaysGb": null, "totalWriteLast7DaysGb": null, "limitReadMbps": null, "limitWriteMbps": null, "limitWriteIops": null, "throttledAt": null, "expiresAt": null, "escalationLevel": 0, "removableByCustomer": true }, "cpuLimit": { "active": false, "vcpus": null, "limitVcpus": null, "limitPercent": null, "averageLoadPercent": null, "measuredDays": null, "limitedAt": null, "liftBelowLoadPercent": null }}Response fields
idstringnamestringprimaryIpstring or nullserviceStatusstringactive, suspended, terminated, pending, cancelled, expired, fraud, transferred_out, unknown.powerStatestring or nullrunning, stopped, starting, stopping, paused, provisioning, error, unknown.operatingSystemobject or nullcustomerMetadataobjectname or operatingSystem.displayNamestring or nulloperatingSystemNamestring or nulloperatingSystemSourceNamestring or nulloperatingSystemName.updatedAtstring or nullbillingobjectamountnumber or nullcurrencyCodestringbillingCyclestring or nullmonthly. Use isPayg to tell it apart from a fixed-cycle VPS. One of monthly, quarterly, semiannually, annually, biennially, triennially, free.isPaygbooleanperiodYearsinteger or nullpaidPeriodobjectentitledThroughDatestring or nullreviewHandledbooleanneeds_review status with a coverage decision. It does not mark any invoice paid or remove one.decisionRevisionintegerrevision. A higher value is newer. At least 0.revisionintegerrefreshRevisionintegerrevision. At least 0.statusstringverified: paidThroughDate is confirmed. Show it. refreshing: the period is being read again. paidThroughDate is the last confirmed date, or null. needs_review: the period could not be confirmed automatically and Hostup checks it. Do not show a date. unavailable: no paid period can be shown now. One of verified, refreshing, needs_review, unavailable.paidThroughDatestring or nulloutstandingInvoiceDueDatestring or nullsourceInvoiceNumbersarray of stringobservedAtstring or nullscheduledChangenullGET /api/v2/vps/{id}/actions/upgrade. billing stays the price of the running period. scheduledChange.target.billing is the price from effectiveAt. null when nothing is waiting. Absent when the state could not be read.resourcesobjectcpuCoresnumbermemoryGbnumberstorageGbnumberbandwidthobjectusedGbnumberlimitGbnumberinboundGbnumberoutboundGbnumberhasOveragebooleanavailabilityobjectavailablebooleanreasonstring or nulltagsarray of stringpinnedbooleancreatedAtstring or nullexpiresAtstring or nullpaidPeriod.paidThroughDate for the last paid day. Null when not set.pendingMaintenancebooleaninclude=pendingMaintenance.pendingMaintenanceHasDeadlinebooleanpendingMaintenance.diskThrottleobjectactive: false means it was checked and no disk limit is active.activebooleanlimitedReadbooleanlimitedWritebooleanreadDrpdnumber or nullwriteDwpdnumber or nulldiskSizeGbnumber or nullestimatedDailyReadGbnumber or nullestimatedDailyWriteGbnumber or nulltotalReadLast7DaysGbnumber or nulltotalWriteLast7DaysGbnumber or nulllimitReadMbpsnumber or nulllimitWriteMbpsnumber or nulllimitWriteIopsnumber or nullthrottledAtstring or nullexpiresAtstring or nullescalationLevelintegerremovableByCustomerbooleanDELETE /api/v2/vps/{id}/disk-throttle then answers 403 disk_throttle_requires_support. True otherwise, also when no limit is active.cpuLimitobjectactive: false means it was checked and there is no limit. Absent when it could not be read.activebooleanvcpusnumber or nulllimitVcpusnumber or nullvcpus).limitPercentnumber or nullaverageLoadPercentnumber or nullmeasuredDaysnumber or nulllimitedAtstring or nullliftBelowLoadPercentnumber or nullguestAgentSetupUntilstring or nullGET /api/v2/vps/{id}.overdueInvoicesarray of objectGET /api/v2/vps/{id}.idstringinv_…).numberstring or nullamountnumbercurrencyCodestringdueAtstring or nulldaysOverdueinteger or nullmatchesVpsbooleanmatchesVps is false.hardwareobjectGET /api/v2/vps/{id}, not on the list. A field is null when it cannot be read now, for example for a pending or terminated VPS. Null means unknown, not an error.cpuModelstring or nullAMD EPYC 7R13.cpuVendorstring or nullamd, intel, other.guestCpuModelstring or nulllscpu. It is a virtual CPU profile, not the physical chip: EPYC-Rome-v5 or EPYC-Milan on AMD hosts, Cascade Lake on Intel hosts. After a CPU type change the VPS keeps its old type until the next restart. The physical CPU is cpuModel.suspendedAtstring or nullGET /api/v2/vps/{id}, while the VPS is suspended, terminated or cancelled. Null when no date is recorded.terminatedAtstring or nullGET /api/v2/vps/{id}, for a terminated or cancelled VPS. Null when no date is recorded.backupRetentionobjectGET /api/v2/vps/{id}, for a terminated or cancelled VPS.statusstringretained, deleted, none, unknown.backupCountinteger or nullretained) or removed after the VPS ended (deleted). 0 for none. Null when unknown.latestBackupAtstring or nulldeleteAfterstring or nullretained only. The earliest time the stored backups may be deleted automatically.deletedAtstring or nulldeleted only. When the last backup was removed.deletionReasonstring or nulldeleted only. retention_elapsed: the retention period after termination ended. removed_by_staff: removed by Hostup support. Null when not recorded. One of retention_elapsed, removed_by_staff.reasonstringErrors
Errors are Problem Details with a stable code. Branch on the code, not on the text.
| 400 | Invalid request. The response body is an RFC 7807 Problem Details document. |
| 401 | Unauthorized. Authentication is required. |
| 403 | forbidden. With requiredScopes in the body, the API key lacks a scope. Without it, the VPS belongs to another account, or your account is not active (detail says which). The other VPS endpoints answer 404 vps_not_found for a VPS on another account, so treat this 403 as not found. |
| 404 | No VPS with this ID (not_found). This endpoint answers not_found, not vps_not_found like the other VPS endpoints, so check for both codes. |
| 429 | Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers. |
| 500 | Internal error. Retry later or contact support if the issue persists. |