List domains

GET /api/v2/domains

Return domains on the account with canonical lifecycle, billing, dates, tags, pin state, customer-action state, and any contact-details warning.

actionRequired is server-computed from current actionable registration, transfer, and renewal failures; a registration failure only applies while the domain is still in a pending-registration state.

When true, follow GET /api/v2/domains/{id}/lifecycle for the reason and recovery action.

Use name=example.com to find the public dom_... ID when the caller only knows the domain name; do not pass FQDNs as {id} to detail/action routes.

Use GET /api/v2/domains/{id} for nameservers, transfer secrets state, pending orders, registry-lock gates, and other per-domain actions.

Domains & DNS Domains

Authentication

Required API scope: read:domains

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

Context

Query Parameters

limit integer · min: 1 · max: 1000 · default: 1000

Maximum domains to return in this page.

cursor string

Opaque cursor from nextCursor for the next page.

include string · Example: hostingConnection

Comma-separated optional expansions. Currently supports hostingConnection.

name string · Example: example.com

Exact domain name to find, for example example.com. Use this to get the public dom_... ID before calling domain detail or action endpoints.

Headers

Authorization Bearer <token>
Accept application/json

Responses

200 Cursor-paginated list.
data array<object>
data[].id string required · Example: dom_01hxa3b4c5d6e7f8g9h0j1k2m3
data[].name string required · Example: example.com
data[].serviceStatus string · enum required · Example: active
active
suspended
terminated
pending
cancelled
expired
fraud
unknown
data[].actionRequired boolean required · Example: false

True when the customer must take an action before domain processing can continue. Historical registration failures are ignored after the domain leaves its pending-registration state. Follow the domain lifecycle endpoint for the reason and available recovery action.

data[].orderId string · Example: ord_01hxa3b4c5d6e7f8g9h0j1k2m3
data[].lifecycle object required
data[].lifecycle.type string required · Example: standard

Normalized lifecycle type. Common values are standard, registration, transfer, and renewal.

data[].lifecycle.autoRenewEnabled boolean · nullable required · Example: true

Nullable: may be null when not applicable.

data[].lifecycle.registrarLockEnabled boolean · nullable required · Example: false

Nullable: may be null when not applicable.

data[].lifecycle.transferInProgress boolean required · Example: false
data[].billing object required
data[].billing.amount number required · Example: 159
data[].billing.currencyCode string required · Example: SEK
data[].billing.billingCycle string · nullable · enum required · Example: annually

Canonical cycle slug for 1-3 year periods. Four- to nine-year domain periods return null and use periodYears.

annually
biennially
triennially
data[].billing.periodYears integer · nullable · min: 1 · max: 9 required · Example: 1

Nullable: may be null when not applicable.

data[].billing.initialAmount number · Example: 99

First-period amount when it differs from the recurring amount.

data[].createdAt string · nullable required · Example: 2025-04-27T09:00:00.000Z

Nullable: may be null when not applicable.

data[].expiresAt string · nullable required · Example: 2027-04-27T21:59:59.000Z

Nullable: may be null when not applicable.

data[].nextDueAt string · nullable required · Example: 2027-03-28T00:00:00.000Z

Nullable: may be null when not applicable.

data[].tags array<string> required · Example: ["production"]
data[].pinned boolean required · Example: false
data[].contactDetailsVerification null required · Example: null

Current contact-details warning for this domain, or null when no update is required.

data[].hostingConnection object
data[].hostingConnection.type string · enum required · Example: hosting
standalone
hosting
wordpress
data[].hostingConnection.hostingAccountId string · nullable required · Example: acct_01hxa3b4c5d6e7f8g9h0j1k2m3

Nullable: may be null when not applicable.

data[].hostingConnection.hostingAccountName string · nullable required · Example: Webbhotell Start

Nullable: may be null when not applicable.

data[].hostingConnection.hostingAccountDomain string · nullable required · Example: example.com

Nullable: may be null when not applicable.

data[].hostingConnection.ssl object · nullable required

Nullable: may be null when not applicable.

hasMore boolean · Example: false
nextCursor string · nullable · Example: null

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/domains
For AI assistants
View as Markdown
cURL 
curl -X GET "https://cloud.hostup.se/api/v2/domains" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
Response 
{
  "data": [
    {
      "id": "dom_01hxa3b4c5d6e7f8g9h0j1k2m3",
      "name": "example.com",
      "serviceStatus": "active",
      "actionRequired": false,
      "lifecycle": {
        "type": "registration",
        "autoRenewEnabled": true,
        "registrarLockEnabled": false,
        "transferInProgress": false
      },
      "billing": {
        "amount": 159,
        "currencyCode": "SEK",
        "billingCycle": "annually",
        "periodYears": 1
      },
      "createdAt": "2025-04-27T09:00:00.000Z",
      "expiresAt": "2027-04-27T21:59:59.000Z",
      "nextDueAt": "2027-03-28T00:00:00.000Z",
      "tags": [
        "production"
      ],
      "pinned": false,
      "contactDetailsVerification": null
    }
  ],
  "hasMore": false,
  "nextCursor": null
}