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
idstringrequiredvps_…).Example
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.
{ "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
idstringvps_…).productNamestring or nullVPS XS.hostnamestring or nullserviceStatusstringactive, pending, suspended, terminated, cancelled, unknown.createdAtstring or nullexpiresAtstring or nullpaidPeriodobjectstatus 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 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 nullnextDueAtstring or nullbillingobjectamountnumber or nullcurrencyCodestringamount, ISO 4217.billingCyclestringmonthly for a Cloud VPS. One of monthly, quarterly, semiannually, annually, biennially, triennially, free.isPaygbooleancpuCoresnumbermemoryGbnumberstorageGbnumberbackupsIncludedintegerbandwidthobjectusedGbnumberlimitGbnumberinboundGbnumberoutboundGbnumberusagePercentnumberusedGb as a share of limitGb, 0 to 100.hasOveragebooleanoneTimeIncreaseobject | nulllimitGb until endsAt, when the bandwidth counter resets. It does not renew: billing.amount covers renewalLimitGb. null when the VPS has no one-time increase.extraGbnumberlimitGb.renewalLimitGbnumberendsAt, which is what the recurring price covers.endsAtstringbandwidthUsageobjectbandwidth.inboundGb and bandwidth.outboundGb.dataReceivedGbnumberdataSentGbnumberusageLogarray of objectrecordedAtstringdataReceivedGbnumberdataSentGbnumbertotalGbnumberipAddressesarray of stringipv4string or nullipv6string or nulloperatingSystemobject | nulldisplayNamestringfamilystring or nullubuntu, debian, almalinux, rocky, centos, fedora, windows.versionstring or nullvariantstring or nullcustomerMetadataobjecthostname or operatingSystem.displayNamestring or nulloperatingSystemNamestring or nulloperatingSystemSourceNamestring or nullupdatedAtstring or nullpowerStatestring or nullrunning, stopped, starting, stopping, paused, provisioning, error, unknown.operationStateobjectlockedbooleansshKeysarray of stringaccessobjectusernamestring or nullroot.rootPasswordstring or nullpricingobject or nullbilling for the price and GET /api/v2/vps/{id}/billing-breakdown for the add-ons.pinnedbooleanavailabilityobjectavailablebooleanreasonstring or nullactionsobjectallowed 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.canRebuildobjectallowedbooleanreasonstring or nullallowed is true.canResetPasswordobjectallowedbooleanreasonstring or nullallowed is true.canResetSshKeysobjectallowedbooleanreasonstring or nullallowed is true.canResizeDiskobjectallowedbooleanreasonstring or nullallowed is true.canAddDiskobjectallowedbooleanreasonstring or nullallowed is true.canSnapshotobjectallowedbooleanreasonstring or nullallowed is true.canBackupobjectallowedbooleanreasonstring or nullallowed is true.canChangeBillingCycleobjectallowedbooleanreasonstring or nullallowed is true.canUpgradeobjectallowedbooleanreasonstring or nullallowed is true.canResizeobjectallowedbooleanreasonstring or nullallowed is true.canDetachIsosobjectallowedbooleanreasonstring or nullallowed is true.canConvertToCloudobjectallowedbooleanreasonstring or nullallowed is true.canStartobjectallowedbooleanreasonstring or nullallowed is true.canStopobjectallowedbooleanreasonstring or nullallowed is true.canRestartobjectallowedbooleanreasonstring or nullallowed is true.canShutdownobjectallowedbooleanreasonstring or nullallowed is true.canResetobjectallowedbooleanreasonstring or nullallowed is true.canCancelobjectallowedbooleanreasonstring or nullallowed is true.canToggleAutorenewobjectallowedbooleanreasonstring or nullallowed is true.canExtendMaintenanceobjectallowedbooleanreasonstring or nullallowed is true.canCancelJobobjectallowedbooleanreasonstring or nullallowed is true.overdueInvoicesarray of objectmatchesVps: false. An active VPS that has used up its bandwidth lists its open bandwidth invoice here. Empty in every other case.idstringPOST /api/v2/billing/invoices/{id}/actions/pay.numberstring or nullamountnumbercurrencyCodestringdueAtstring or nulldaysOverdueinteger or nullmatchesVpsbooleandiskThrottleobjectactive: false means there is none.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 answers 403 disk_throttle_requires_support. True otherwise, also when no limit is active.cpuLimitobjectliftBelowLoadPercent. It cannot be removed through the API. active: false means 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 nullautoDeletionobjectnone in every other case.statusstringnone: 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 nullstatus is none.daysUntilinteger or nullearliestAt. 0 when it is today. Null unless status is scheduled.reasonstring or nullstatus is none.scheduledChangeobject | nullbilling stays the price of the running period. Null when nothing is pending. Absent when it could not be read.statusstringpreview, scheduled, awaiting_payment, paid, applying, applied, needs_attention, cancelling, cancelled.effectiveAtstring or nullinvoiceIssueAtstring or nulltargetobjectproductSlugstringresourcesobjectstorageGb can be larger than the new plan’s disk. The primary disk cannot be made smaller.billingobjectamountnumber or nullcurrencyCodestringbillingCyclestringmonthly, quarterly, semiannually, annually, biennially, triennially, free.actionsobjectcanCancelobjectallowedbooleanreasonstring or nullallowed is true.Errors
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: 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. |
| 404 | Not found. The resource does not exist or is not owned by the caller; code is vps_not_found. |
| 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. |