List web hosting accounts
GET /api/v2/shared-hosting
Lists the web hosting accounts on your Hostup account, sorted by name. Cancelled and terminated accounts are left out. Each account has its status, price and billing cycle, due dates, plan resources and control panel. Use data[].id (acct_…) as {accountId} on the other web hosting endpoints.
actions is always null in this list. The action gates are on GET /api/v2/shared-hosting/{accountId}.
Authentication: An API key with the scope read:services. About keys and scopes
Request
Query parameters
limitintegerAccounts per page, 1 to 100. Default 20. Default
20. 1 to 100.cursorstringThe
nextCursor value from the previous page.includestringExtra data per account. Repeat the parameter or separate values with commas.
billingCycleOptions fills billingCycleState with the billing cycles you can switch to. domains fills domains with the main, addon and parked domains, without subdomains. Without domains, domains holds only the primary domain. One of billingCycleOptions, domains.Example
curl "https://cloud.hostup.se/api/v2/shared-hosting" \ -H "Authorization: Bearer $HOSTUP_API_KEY"Responses
200 A page of web hosting accounts.
{ "data": [ { "id": "acct_01hxa3b4c5d6e7f8g9h0j1k2m3", "name": "example.com", "primaryDomain": "example.com", "domains": [ "example.com" ], "customName": "Main hosting account", "serviceStatus": "active", "billing": { "amount": 1188, "currencyCode": "SEK", "billingCycle": "annually" }, "createdAt": "2026-04-27T12:34:56.000Z", "nextDueAt": "2027-04-27T12:00:00.000Z", "expiresAt": null, "pinned": false, "resources": { "storageGb": 100, "memoryGb": 4, "cpuPercent": 800, "diskLimitGb": 100 }, "controlPanel": { "type": "cpanel" }, "billingCycleState": { "billingCycleOptions": [ { "billingCycle": "annually", "amount": 1188, "currencyCode": "SEK", "isCurrent": true, "savingsPercent": 34 } ], "actions": { "canSwitchCycle": { "allowed": false, "reason": "No alternative billing cycles are available for this account." } } }, "actions": null, "tags": [] } ], "hasMore": false, "nextCursor": null}Response fields
dataarray of objectidstringnamestringThe plan’s name, such as
Start (cpanel). Use primaryDomain or customName to tell accounts apart. The list is sorted by this field.primaryDomainstring or nulldomainsarray of stringDomains on this account. List responses usually include only the primary domain.
customNamestring or nullThe name you gave the account with
PATCH /api/v2/shared-hosting/{accountId}, or null.serviceStatusstringOne of
active, pending, suspended, cancelled, terminated, expired, fraud, transferred_out, unknown.billingobjectamountnumbercurrencyCodestringbillingCyclestring or nullOne of
monthly, quarterly, semiannually, annually, biennially, triennially, free.createdAtstring or nullnextDueAtstring or nullexpiresAtstring or nullpinnedbooleanresourcesobject or nullcontrolPanelobjecttypestringOne of
cpanel.supportsWhmbooleanPresent only when the account has WHM access.
billingCycleStateobject | nullbillingCycleOptionsarray of objectbillingCyclestringOne of
monthly, quarterly, semiannually, annually, biennially, triennially, free.amountnumberinitialAmountnumberPresent only when the first payment differs from the recurring price.
currencyCodestringisCurrentbooleansavingsPercentnumber or nullactionsobjectcanSwitchCycleobjectallowedbooleanreasonstring or nullcodestring or nullA machine-readable code for why the action is blocked.
actionsnullAlways null in this list. The action gates are on
GET /api/v2/shared-hosting/{accountId}.tagsarray of stringhasMorebooleannextCursorstring or nullErrors
Errors are Problem Details with a stable code. Branch on the code, not on the text.
| 400 | limit is not an integer from 1 to 100 (invalid_pagination_limit), or cursor is not a value from nextCursor (invalid_cursor). |
| 401 | Unauthorized. Authentication is required. |
| 403 | Forbidden. The caller lacks a required scope or does not own the resource. |
| 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. |
| 503 | The account details could not be loaded. Retry the request. |