Skip to content

Get VPS details and action gates

GET /api/v2/vps/{id}/details

Get one VPS with everything you need before acting on it: the action gates, the root login, SSH keys, bandwidth use, unpaid invoices, disk and CPU limits and the risk of automatic deletion. Each gate, such as actions.canRestart, has allowed and a reason that says why an action is blocked. GET /api/v2/vps/{id} returns the list view of the VPS with tags and the host CPU but without the gates. billing.isPayg is true for a Cloud VPS. Its billing.amount is then null. A suspended VPS with an unpaid invoice is deleted automatically and permanently 15 days after the invoice’s due date. autoDeletion gives that date.

Authentication: An API key with the scope read:vm. About keys and scopes

Request

Path parameters

idstringrequired
The VPS ID (vps_…).

Example

GET /api/v2/vps/{id}/details
curl "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/details" \
-H "Authorization: Bearer $HOSTUP_API_KEY"

Responses

200 The VPS with its action gates.

Response 200
{
"id": "vps_01hxa3b4c5d6e7f8g9h0j1k2m3",
"productName": "VPS XS",
"hostname": "web-01.example.com",
"serviceStatus": "active",
"createdAt": "2026-04-27T12:00:00.000Z",
"expiresAt": "2026-05-27T00:00:00.000Z",
"nextDueAt": "2026-05-27T00:00:00.000Z",
"billing": {
"amount": 40.5,
"currencyCode": "SEK",
"billingCycle": "monthly",
"isPayg": false
},
"cpuCores": 2,
"memoryGb": 4,
"storageGb": 80,
"backupsIncluded": 2,
"bandwidth": {
"usedGb": 12.5,
"limitGb": 1000,
"inboundGb": 4.2,
"outboundGb": 8.3,
"usagePercent": 1.25,
"hasOverage": false,
"oneTimeIncrease": null
},
"bandwidthUsage": {
"dataReceivedGb": 4.2,
"dataSentGb": 8.3
},
"usageLog": [
{
"recordedAt": "2026-04-27T00:00:00.000Z",
"dataReceivedGb": 0.5,
"dataSentGb": 1,
"totalGb": 1.5
}
],
"ipAddresses": [
"192.0.2.10"
],
"ipv4": "192.0.2.10",
"ipv6": "2001:db8::10",
"operatingSystem": {
"displayName": "Ubuntu 24.04",
"family": "ubuntu",
"version": "24.04",
"variant": null
},
"customerMetadata": {
"displayName": "Production DB",
"operatingSystemName": "Debian 13",
"operatingSystemSourceName": "Debian 12",
"updatedAt": "2026-06-30T10:00:00.000Z"
},
"powerState": "running",
"operationState": {
"locked": false
},
"sshKeys": [
"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIexample user@example.com"
],
"access": {
"username": "root",
"rootPassword": "example-root-password"
},
"pricing": {
"currency": "SEK",
"currencyCode": "SEK",
"billingCycle": {
"id": "monthly",
"months": 1,
"isFree": false
},
"pricePerCycle": 40.5,
"baseMonthlyCost": 39,
"baseAnnualCost": 468,
"addonsMonthlyCost": 1.5,
"addonsAnnualCost": 18,
"totalMonthlyCost": 40.5,
"totalAnnualCost": 486,
"addons": [
{
"id": "storage-addon",
"name": "Attachable Block Storage",
"category": "storage",
"unit": "GB",
"included": 50,
"quantity": 100,
"unitPriceMonthly": 0.03,
"monthlyCost": 1.5,
"annualCost": 18,
"currencyCode": "SEK"
}
]
},
"pinned": false,
"actions": {
"canRebuild": {
"allowed": true,
"reason": null
},
"canResetPassword": {
"allowed": true,
"reason": null
},
"canResetSshKeys": {
"allowed": true,
"reason": null
},
"canResizeDisk": {
"allowed": true,
"reason": null
},
"canAddDisk": {
"allowed": true,
"reason": null
},
"canSnapshot": {
"allowed": false,
"reason": "Snapshot availability could not be confirmed."
},
"canBackup": {
"allowed": false,
"reason": "Backup availability could not be confirmed."
},
"canChangeBillingCycle": {
"allowed": true,
"reason": null
},
"canUpgrade": {
"allowed": true,
"reason": null
},
"canResize": {
"allowed": false,
"reason": "Resize is a PAYG-only action. Use upgrade for fixed plans."
},
"canDetachIsos": {
"allowed": false,
"reason": "No ISOs attached."
},
"canConvertToCloud": {
"allowed": true,
"reason": null
},
"canStart": {
"allowed": false,
"reason": "VPS is already running."
},
"canStop": {
"allowed": true,
"reason": null
},
"canRestart": {
"allowed": true,
"reason": null
},
"canShutdown": {
"allowed": true,
"reason": null
},
"canReset": {
"allowed": true,
"reason": null
},
"canCancel": {
"allowed": true,
"reason": null
},
"canToggleAutorenew": {
"allowed": true,
"reason": null
},
"canExtendMaintenance": {
"allowed": false,
"reason": "No pending maintenance to extend."
},
"canCancelJob": {
"allowed": false,
"reason": "No active jobs to cancel."
}
},
"availability": {
"available": true,
"reason": null
},
"overdueInvoices": [],
"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
},
"autoDeletion": {
"status": "none",
"earliestAt": null,
"daysUntil": null,
"reason": null
},
"scheduledChange": null
}
Response fields
idstring
The VPS ID (vps_…).
productNamestring or null
Plan name, for example VPS XS.
hostnamestring or null
Hostname set for the VPS.
serviceStatusstring
Status of the service in billing. One of active, pending, suspended, terminated, cancelled, unknown.
createdAtstring or null
When the VPS was created.
expiresAtstring or null
Expiry date recorded for the service in billing. Null when none is set.
paidPeriodobject
The period the VPS is paid for. Check its status before you show it. Show paidThroughDate only when status is verified or refreshing. Absent for a Cloud VPS and for a VPS that is not active.
entitledThroughDatestring or null
The last day of extra coverage granted on top of what was paid. Show it as “covered through”, not “paid through”. Null when there is none.
reviewHandledboolean
True when Hostup has already handled a needs_review status with a coverage decision. It does not mark any invoice paid or remove one.
decisionRevisioninteger
Version of the coverage decision, counted apart from revision. A higher value is newer. At least 0.
revisioninteger
Version of the paid period. A higher value is newer. At least 0.
refreshRevisioninteger
Refresh round of the paid period. When you merge two reads, compare it before revision. At least 0.
statusstring
verified: 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 null
The last paid day, inclusive, in Swedish time (Europe/Stockholm). It is not an invoice due date or a suspension date.
outstandingInvoiceDueDatestring or null
sourceInvoiceNumbersarray of string
observedAtstring or null
nextDueAtstring or null
Due date of the next invoice. Null when none is set.
billingobject
amountnumber or null
Price per billing period. Null for a Cloud VPS, which is billed by usage.
currencyCodestring
Currency of amount, ISO 4217.
billingCyclestring
Billing period. monthly for a Cloud VPS. One of monthly, quarterly, semiannually, annually, biennially, triennially, free.
isPaygboolean
True for a Cloud VPS, which is billed by usage.
cpuCoresnumber
Number of vCPUs.
memoryGbnumber
RAM in GB.
storageGbnumber
Disk size in GB.
backupsIncludedinteger
Number of backups included in the plan.
bandwidthobject
usedGbnumber
Traffic used in the current period, in GB.
limitGbnumber
Traffic allowed in the current period, in GB.
inboundGbnumber
Traffic received in the current period, in GB.
outboundGbnumber
Traffic sent in the current period, in GB.
usagePercentnumber
usedGb as a share of limitGb, 0 to 100.
hasOverageboolean
True when the limit is used up.
oneTimeIncreaseobject | null
Paid one-time bandwidth increase that is part of limitGb until endsAt, when the bandwidth counter resets. It does not renew: billing.amount covers renewalLimitGb. null when the VPS has no one-time increase.
extraGbnumber
Temporary allowance included in limitGb.
renewalLimitGbnumber
Bandwidth limit after endsAt, which is what the recurring price covers.
endsAtstring
When the increase ends and the bandwidth counter resets.
bandwidthUsageobject
The same received and sent totals as bandwidth.inboundGb and bandwidth.outboundGb.
dataReceivedGbnumber
dataSentGbnumber
usageLogarray of object
recordedAtstring
dataReceivedGbnumber
dataSentGbnumber
totalGbnumber
ipAddressesarray of string
All IP addresses on the VPS.
ipv4string or null
Primary IPv4 address. Null when the VPS has none.
ipv6string or null
Primary IPv6 address. Null when the VPS has none.
operatingSystemobject | null
The installed operating system. Null when unknown.
displayNamestring
familystring or null
One of ubuntu, debian, almalinux, rocky, centos, fedora, windows.
versionstring or null
variantstring or null
customerMetadataobject
Your own labels for the VPS. They do not change hostname or operatingSystem.
displayNamestring or null
operatingSystemNamestring or null
operatingSystemSourceNamestring or null
updatedAtstring or null
powerStatestring or null
Power state of the VPS. Null when it was not reported. One of running, stopped, starting, stopping, paused, provisioning, error, unknown.
operationStateobject
lockedboolean
True while a running operation has locked the VPS.
sshKeysarray of string
SSH public keys on the VPS.
accessobject
usernamestring or null
The login user, for example root.
rootPasswordstring or null
The root password from the install or the last password reset. A password changed inside the server is not shown here. Null when none is stored.
pricingobject or null
Deprecated. Use billing for the price and GET /api/v2/vps/{id}/billing-breakdown for the add-ons.
pinnedboolean
Always false on this read. The pin is not looked up here.
availabilityobject
availableboolean
False when the VPS cannot be used, for example while it is suspended.
reasonstring or null
Why the VPS cannot be used. Null when it can.
actionsobject
One gate per action. Check allowed before you call the action. reason says why it is blocked. The gates do not cover a used-up bandwidth limit. When bandwidth.hasOverage is true, rebuild, start, restart and reset answer 403 even when their gate is allowed.
canRebuildobject
allowedboolean
True when the action can be called now.
reasonstring or null
Why the action is blocked, ready to show. Null when allowed is true.
canResetPasswordobject
allowedboolean
True when the action can be called now.
reasonstring or null
Why the action is blocked, ready to show. Null when allowed is true.
canResetSshKeysobject
allowedboolean
True when the action can be called now.
reasonstring or null
Why the action is blocked, ready to show. Null when allowed is true.
canResizeDiskobject
allowedboolean
True when the action can be called now.
reasonstring or null
Why the action is blocked, ready to show. Null when allowed is true.
canAddDiskobject
allowedboolean
True when the action can be called now.
reasonstring or null
Why the action is blocked, ready to show. Null when allowed is true.
canSnapshotobject
allowedboolean
True when the action can be called now.
reasonstring or null
Why the action is blocked, ready to show. Null when allowed is true.
canBackupobject
allowedboolean
True when the action can be called now.
reasonstring or null
Why the action is blocked, ready to show. Null when allowed is true.
canChangeBillingCycleobject
allowedboolean
True when the action can be called now.
reasonstring or null
Why the action is blocked, ready to show. Null when allowed is true.
canUpgradeobject
allowedboolean
True when the action can be called now.
reasonstring or null
Why the action is blocked, ready to show. Null when allowed is true.
canResizeobject
allowedboolean
True when the action can be called now.
reasonstring or null
Why the action is blocked, ready to show. Null when allowed is true.
canDetachIsosobject
allowedboolean
True when the action can be called now.
reasonstring or null
Why the action is blocked, ready to show. Null when allowed is true.
canConvertToCloudobject
allowedboolean
True when the action can be called now.
reasonstring or null
Why the action is blocked, ready to show. Null when allowed is true.
canStartobject
allowedboolean
True when the action can be called now.
reasonstring or null
Why the action is blocked, ready to show. Null when allowed is true.
canStopobject
allowedboolean
True when the action can be called now.
reasonstring or null
Why the action is blocked, ready to show. Null when allowed is true.
canRestartobject
allowedboolean
True when the action can be called now.
reasonstring or null
Why the action is blocked, ready to show. Null when allowed is true.
canShutdownobject
allowedboolean
True when the action can be called now.
reasonstring or null
Why the action is blocked, ready to show. Null when allowed is true.
canResetobject
allowedboolean
True when the action can be called now.
reasonstring or null
Why the action is blocked, ready to show. Null when allowed is true.
canCancelobject
allowedboolean
True when the action can be called now.
reasonstring or null
Why the action is blocked, ready to show. Null when allowed is true.
canToggleAutorenewobject
allowedboolean
True when the action can be called now.
reasonstring or null
Why the action is blocked, ready to show. Null when allowed is true.
canExtendMaintenanceobject
allowedboolean
True when the action can be called now.
reasonstring or null
Why the action is blocked, ready to show. Null when allowed is true.
canCancelJobobject
allowedboolean
True when the action can be called now.
reasonstring or null
Why the action is blocked, ready to show. Null when allowed is true.
overdueInvoicesarray of object
Unpaid invoices for this VPS. They are looked up while the VPS is suspended or pending. When none has a line for this VPS, up to three of the account’s oldest unpaid invoices are listed with matchesVps: false. An active VPS that has used up its bandwidth lists its open bandwidth invoice here. Empty in every other case.
idstring
Invoice ID. Pay it with POST /api/v2/billing/invoices/{id}/actions/pay.
numberstring or null
amountnumber
Amount still to pay, not the invoice total.
currencyCodestring
dueAtstring or null
daysOverdueinteger or null
Days past the due date. Null when the invoice is not overdue yet.
matchesVpsboolean
True when the invoice has a line for this VPS. False for an unpaid invoice on the account that could not be tied to a VPS.
diskThrottleobject
Disk speed limit set because of heavy disk use. active: false means there is none.
activeboolean
True when an active disk throttle exists for this VPS.
limitedReadboolean
limitedWriteboolean
readDrpdnumber or null
Disk reads per disk per day, when reads triggered the throttle.
writeDwpdnumber or null
Disk writes per disk per day, when writes triggered the throttle.
diskSizeGbnumber or null
estimatedDailyReadGbnumber or null
estimatedDailyWriteGbnumber or null
totalReadLast7DaysGbnumber or null
Total read over the last 7 days. Null when the limit measured fewer days.
totalWriteLast7DaysGbnumber or null
Total written over the last 7 days. Null when the limit measured fewer days. A limit that follows an earlier one counts only the days after that one ended. The 24-hour rule counts one day.
limitReadMbpsnumber or null
limitWriteMbpsnumber or null
limitWriteIopsnumber or null
Highest write operations per second while the limit is active. Null when the limit sets only MB/s.
throttledAtstring or null
expiresAtstring or null
escalationLevelinteger
At least 0.
removableByCustomerboolean
False for the third write limit within 30 days. Support lifts that one after a review and DELETE /api/v2/vps/{id}/disk-throttle answers 403 disk_throttle_requires_support. True otherwise, also when no limit is active.
cpuLimitobject
CPU limit under the Acceptable Use Policy (section 2.3). It is set after a week at full load. The VPS may then use CPU time equal to half its vCPUs. It is lifted automatically once the last 24 hours averaged under liftBelowLoadPercent. It cannot be removed through the API. active: false means there is no limit. Absent when it could not be read.
activeboolean
True when a CPU limit is active on this VPS.
vcpusnumber or null
vCPUs when the limit was set or last adjusted.
limitVcpusnumber or null
CPU time the VPS may use, in vCPUs (half of vcpus).
limitPercentnumber or null
The cap as a percentage of all vCPUs.
averageLoadPercentnumber or null
The average load, as a percentage of all vCPUs, that set the limit.
measuredDaysnumber or null
Days that average covers. Usually 7. It is 1 when the load came back within 30 days of an earlier limit being lifted.
limitedAtstring or null
liftBelowLoadPercentnumber or null
The limit is lifted once the last 24 hours averaged under this percentage of all vCPUs.
autoDeletionobject
Risk of automatic deletion for a suspended VPS with an overdue invoice. An unpaid VPS is deleted automatically and permanently 15 days after the invoice’s due date. The server and all its data are then gone. none in every other case.
statusstring
none: no risk. scheduled: deletion is ahead, see earliestAt. imminent: the 15 days have passed and the deletion can run any day. One of none, scheduled, imminent.
earliestAtstring or null
Earliest date of the automatic deletion: the oldest unpaid invoice’s due date plus 15 days. Null when status is none.
daysUntilinteger or null
Whole days until earliestAt. 0 when it is today. Null unless status is scheduled.
reasonstring or null
The risk and how to stop it (pay the invoice) in plain words. Null when status is none.
scheduledChangeobject | null
A change that starts at the next renewal, such as a downgrade or a switch to Cloud VPS. billing stays the price of the running period. Null when nothing is pending. Absent when it could not be read.
statusstring
One of preview, scheduled, awaiting_payment, paid, applying, applied, needs_attention, cancelling, cancelled.
effectiveAtstring or null
invoiceIssueAtstring or null
targetobject
productSlugstring
resourcesobject
The resources after the change, as checked by the server. For a VPS plan change storageGb can be larger than the new plan’s disk. The primary disk cannot be made smaller.
billingobject
amountnumber or null
currencyCodestring
billingCyclestring
One of monthly, quarterly, semiannually, annually, biennially, triennially, free.
actionsobject
canCancelobject
allowedboolean
True when the action can be called now.
reasonstring or null
Why the action is blocked, ready to show. Null when allowed is true.

Errors

Errors are Problem Details with a stable code. Branch on the code, not on the text.

400Invalid request. The response body is an RFC 7807 Problem Details document.
401Unauthorized. Authentication is required.
403forbidden: the API key lacks read:vm (requiredScopes lists it) or the account is not active. A VPS on another account answers 404 vps_not_found.
404Not found. The resource does not exist or is not owned by the caller; code is vps_not_found.
429Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers.
500Internal error. Retry later or contact support if the issue persists.