Get hosting usage stats

GET /api/v2/shared-hosting/{accountId}/account-stats

Return account-level shared-hosting usage and quotas for disk, bandwidth, addon domains, subdomains, mailboxes, forwarders, and databases. limit: null means unlimited or no concrete cap was reported.

Web Hosting Hosting Accounts

Authentication

Required API scopes: read:hostingconsole:services

Authenticate with an API key in the Authorization: Bearer <token> header.

Context

Path Parameters

accountId string required Example: acct_01hxa3b4c5d6e7f8g9h0j1k2m3

Public shared-hosting account ID. Get it from GET /api/v2/shared-hosting data[].id. Do not invent this value; use the exact ID returned by the referenced API response.

Headers

Authorization Bearer <token>
Accept application/json

Responses

200 Shared-hosting usage stats.
disk object required
disk.usedBytes number · nullable required · Example: 4294967296

Nullable: may be null when not applicable.

disk.limitBytes number · nullable required · Example: 21474836480

Nullable: may be null when not applicable.

disk.usedGb number required · Example: 4
disk.limitGb number · nullable required · Example: 20

Nullable: may be null when not applicable.

disk.usagePercent number · nullable required · Example: 20

Nullable: may be null when not applicable.

disk.exceeded boolean required · Example: false
bandwidth object required
bandwidth.usedBytes number · nullable required · Example: 4294967296

Nullable: may be null when not applicable.

bandwidth.limitBytes number · nullable required · Example: 21474836480

Nullable: may be null when not applicable.

bandwidth.usedGb number required · Example: 4
bandwidth.limitGb number · nullable required · Example: 20

Nullable: may be null when not applicable.

bandwidth.usagePercent number · nullable required · Example: 20

Nullable: may be null when not applicable.

bandwidth.exceeded boolean required · Example: false
addonDomains object required
addonDomains.used integer required · Example: 2
addonDomains.limit integer · nullable required · Example: 10

Nullable: may be null when not applicable.

addonDomains.remaining integer · nullable required · Example: 8

Nullable: may be null when not applicable.

addonDomains.usagePercent number · nullable required · Example: 20

Nullable: may be null when not applicable.

addonDomains.exceeded boolean required · Example: false
subDomains object required
subDomains.used integer required · Example: 2
subDomains.limit integer · nullable required · Example: 10

Nullable: may be null when not applicable.

subDomains.remaining integer · nullable required · Example: 8

Nullable: may be null when not applicable.

subDomains.usagePercent number · nullable required · Example: 20

Nullable: may be null when not applicable.

subDomains.exceeded boolean required · Example: false
emailAccounts object required
emailAccounts.used integer required · Example: 2
emailAccounts.limit integer · nullable required · Example: 10

Nullable: may be null when not applicable.

emailAccounts.remaining integer · nullable required · Example: 8

Nullable: may be null when not applicable.

emailAccounts.usagePercent number · nullable required · Example: 20

Nullable: may be null when not applicable.

emailAccounts.exceeded boolean required · Example: false
emailForwarders object required
emailForwarders.used integer required · Example: 2
emailForwarders.limit integer · nullable required · Example: 10

Nullable: may be null when not applicable.

emailForwarders.remaining integer · nullable required · Example: 8

Nullable: may be null when not applicable.

emailForwarders.usagePercent number · nullable required · Example: 20

Nullable: may be null when not applicable.

emailForwarders.exceeded boolean required · Example: false
ftpAccounts object required
ftpAccounts.used integer required · Example: 2
ftpAccounts.limit integer · nullable required · Example: 10

Nullable: may be null when not applicable.

ftpAccounts.remaining integer · nullable required · Example: 8

Nullable: may be null when not applicable.

ftpAccounts.usagePercent number · nullable required · Example: 20

Nullable: may be null when not applicable.

ftpAccounts.exceeded boolean required · Example: false
mysqlDatabases object required
mysqlDatabases.used integer required · Example: 2
mysqlDatabases.limit integer · nullable required · Example: 10

Nullable: may be null when not applicable.

mysqlDatabases.remaining integer · nullable required · Example: 8

Nullable: may be null when not applicable.

mysqlDatabases.usagePercent number · nullable required · Example: 20

Nullable: may be null when not applicable.

mysqlDatabases.exceeded boolean required · Example: false
400 Invalid request. The response body is an RFC 7807 Problem Details document.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
401 Unauthorized. Authentication is required.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
403 Forbidden. The caller lacks a required scope or does not own the resource.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
404 Not found. The resource does not exist or is not owned by the caller.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
429 Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
500 Internal error. Retry later or contact support if the issue persists.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
GET https://cloud.hostup.se/api/v2/shared-hosting/{accountId}/account-stats
For AI assistants
View as Markdown
cURL 
curl -X GET "https://cloud.hostup.se/api/v2/shared-hosting/acct_01hxa3b4c5d6e7f8g9h0j1k2m3/account-stats" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
Response 
{
  "disk": {
    "usedBytes": 4294967296,
    "limitBytes": 21474836480,
    "usedGb": 4,
    "limitGb": 20,
    "usagePercent": 20,
    "exceeded": false
  },
  "bandwidth": {
    "usedBytes": 10737418240,
    "limitBytes": 1099511627776,
    "usedGb": 10,
    "limitGb": 1024,
    "usagePercent": 0.98,
    "exceeded": false
  },
  "addonDomains": {
    "used": 1,
    "limit": 5,
    "remaining": 4,
    "usagePercent": 20,
    "exceeded": false
  },
  "subDomains": {
    "used": 3,
    "limit": 50,
    "remaining": 47,
    "usagePercent": 6,
    "exceeded": false
  },
  "emailAccounts": {
    "used": 2,
    "limit": 25,
    "remaining": 23,
    "usagePercent": 8,
    "exceeded": false
  },
  "emailForwarders": {
    "used": 1,
    "limit": null,
    "remaining": null,
    "usagePercent": null,
    "exceeded": false
  },
  "ftpAccounts": {
    "used": 2,
    "limit": 10,
    "remaining": 8,
    "usagePercent": 20,
    "exceeded": false
  },
  "mysqlDatabases": {
    "used": 3,
    "limit": 10,
    "remaining": 7,
    "usagePercent": 30,
    "exceeded": false
  }
}