Skip to content

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

limitinteger
Accounts per page, 1 to 100. Default 20. Default 20. 1 to 100.
cursorstring
The nextCursor value from the previous page.
includestring
Extra 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

GET /api/v2/shared-hosting
curl "https://cloud.hostup.se/api/v2/shared-hosting" \
-H "Authorization: Bearer $HOSTUP_API_KEY"

Responses

200 A page of web hosting accounts.

Response 200
{
"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 object
idstring
namestring
The plan’s name, such as Start (cpanel). Use primaryDomain or customName to tell accounts apart. The list is sorted by this field.
primaryDomainstring or null
domainsarray of string
Domains on this account. List responses usually include only the primary domain.
customNamestring or null
The name you gave the account with PATCH /api/v2/shared-hosting/{accountId}, or null.
serviceStatusstring
One of active, pending, suspended, cancelled, terminated, expired, fraud, transferred_out, unknown.
billingobject
amountnumber
currencyCodestring
billingCyclestring or null
One of monthly, quarterly, semiannually, annually, biennially, triennially, free.
createdAtstring or null
nextDueAtstring or null
expiresAtstring or null
pinnedboolean
resourcesobject or null
controlPanelobject
typestring
One of cpanel.
supportsWhmboolean
Present only when the account has WHM access.
billingCycleStateobject | null
billingCycleOptionsarray of object
billingCyclestring
One of monthly, quarterly, semiannually, annually, biennially, triennially, free.
amountnumber
initialAmountnumber
Present only when the first payment differs from the recurring price.
currencyCodestring
isCurrentboolean
savingsPercentnumber or null
actionsobject
canSwitchCycleobject
allowedboolean
reasonstring or null
codestring or null
A machine-readable code for why the action is blocked.
actionsnull
Always null in this list. The action gates are on GET /api/v2/shared-hosting/{accountId}.
tagsarray of string
hasMoreboolean
nextCursorstring or null

Errors

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

400limit is not an integer from 1 to 100 (invalid_pagination_limit), or cursor is not a value from nextCursor (invalid_cursor).
401Unauthorized. Authentication is required.
403Forbidden. The caller lacks a required scope or does not own the resource.
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.
503The account details could not be loaded. Retry the request.