Get hosting access details

Return shared-hosting access details for automation: primary domain, username, direct server hostname, SSH command, FTP/SFTP settings, email-client settings, server IP, service status, billing, and plan resource limits. Use access.serverHostname for SSH, SFTP, FTP/FTPS, IMAP-sync targets, and mail-client setup when the customer's domain may not point to HostUp yet; do not guess a hostname from the domain name.

Web Hosting Hosting Accounts

Authentication

Required API scope: read:hosting

Use Authorization: Bearer <token> for API keys. Dashboard sessions may also use hostup_session.

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

Accept Example
Content-Type Example

Responses

200 Shared-hosting access details.
id string required · Example: acct_01hxa3b4c5d6e7f8g9h0j1k2m3
name stringnull required · Example: Webbhotell Start
primaryDomain stringnull required · Example: example.com
serviceStatus string required · Example: active
nextDueAt stringnull required · Example: 2026-05-27T00:00:00.000Z
billing object required
billing.amount number required · Example: 99
billing.currencyCode string required · Example: SEK
billing.billingCycle stringnull required · Example: annually
access object required
access.username stringnull required · Example: exampleuser
access.serverHostname stringnull required · Example: srv11.hostup.se

Direct hosting server hostname. Use this for SSH/SFTP/FTPS and as the IMAP/SMTP host when DNS is not pointed at this account yet.

access.sshCommand stringnull required · Example: ssh exampleuser@srv11.hostup.se

Ready-to-run SSH command when both username and server hostname are known.

access.emailClient objectnull required
access.ftp objectnull required

Direct file-transfer settings. Uses the hosting server hostname instead of `ftp.{domain}` so clients can connect before DNS points at this account.

serverIp stringnull required · Example: 203.0.113.10
resources objectnull required
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-details
For AI assistants
View as Markdown
cURL 
curl -X GET "https://cloud.hostup.se/api/v2/shared-hosting/acct_01hxa3b4c5d6e7f8g9h0j1k2m3/account-details" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
Response 
{
  "id": "acct_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "name": "Webbhotell Start",
  "primaryDomain": "example.com",
  "serviceStatus": "active",
  "nextDueAt": "2026-05-27T00:00:00.000Z",
  "billing": {
    "amount": 99,
    "currencyCode": "SEK",
    "billingCycle": "annually"
  },
  "access": {
    "username": "exampleuser",
    "serverHostname": "srv11.hostup.se",
    "sshCommand": "ssh exampleuser@srv11.hostup.se",
    "emailClient": {
      "incomingServer": "srv11.hostup.se",
      "outgoingServer": "srv11.hostup.se",
      "imap": {
        "hostname": "srv11.hostup.se",
        "port": 993,
        "encryption": "ssl_tls"
      },
      "pop3": {
        "hostname": "srv11.hostup.se",
        "port": 995,
        "encryption": "ssl_tls"
      },
      "smtp": {
        "hostname": "srv11.hostup.se",
        "ports": [
          465,
          587
        ],
        "encryption": "ssl_tls"
      },
      "usernameFormat": "full_email_address",
      "webmailUrl": "https://srv11.hostup.se:2096"
    },
    "ftp": {
      "hostname": "srv11.hostup.se",
      "username": "exampleuser",
      "ftps": {
        "hostname": "srv11.hostup.se",
        "port": 21,
        "encryption": "explicit_tls"
      },
      "sftp": {
        "hostname": "srv11.hostup.se",
        "port": 22,
        "encryption": "ssh"
      },
      "usernameFormat": "cpanel_username"
    }
  },
  "serverIp": "203.0.113.10",
  "resources": {
    "diskLimitGb": 20,
    "memoryGb": 2,
    "bandwidthLimitGb": 1024,
    "emailAccountLimit": 25,
    "databaseLimit": 10,
    "ftpAccountLimit": 10,
    "addonDomainLimit": 5,
    "subdomainLimit": 50
  }
}