Get a domain
GET /api/v2/domains/{id}
Get one domain with its status, expiry, billing, nameservers, registry lock, WHOIS privacy and action gates. The actions object says what you can do next and why not. For example, check actions.canDelete before DELETE /api/v2/domains/{id}, actions.canRenewNow before POST /api/v2/domains/{id}/actions/renew and actions.canEnableAutoRenew before turning on auto-renewal with PATCH /api/v2/domains/{id}. pendingRenewalOrder and pendingDomainOrder show an open renewal, registration or transfer order and its invoice. Each is null or an object with the order id, invoiceId, invoiceStatus, amount, currencyCode and dueAt. The contact details are on GET /api/v2/domains/{id}/contacts. The EPP code is never returned here. Use the dom_… ID in the path and do not pass a raw hostname such as example.com. To find a domain by name, list GET /api/v2/domains and match data[].name.
Authentication: An API key with the scope read:domains. About keys and scopes
Request
Path parameters
idstringrequireddom_…), not the domain name.Example
curl "https://cloud.hostup.se/api/v2/domains/dom_01hxa3b4c5d6e7f8g9h0j1k2m3" \ -H "Authorization: Bearer $HOSTUP_API_KEY"Responses
200 The domain.
{ "id": "dom_01hxa3b4c5d6e7f8g9h0j1k2m3", "name": "example.com", "serviceStatus": "active", "actionRequired": false, "awaitingPayment": false, "orderId": "ord_01hxa3b4c5d6e7f8g9h0j1k2m3", "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, "hostingConnection": { "type": "standalone", "hostingAccountId": null, "hostingAccountName": null, "hostingAccountDomain": null, "ssl": null }, "nameservers": [ "primary.ns.hostup.se", "secondary.ns.hostup.se" ], "transfer": { "eppCode": null }, "notes": null, "pendingRenewalOrder": null, "pendingDomainOrder": null, "registryLock": { "enabled": false, "requiresManualUnlockFlow": false, "unlockAction": null, "pausedByHostup": false, "renewalDeadlineAt": null, "renewalUnpaid": false }, "whoisPrivacy": { "enabled": null, "autoEnable": true, "status": "auto_enable_allowed", "reason": null, "updatedAt": "2026-04-20T09:30:00.000Z" }, "actions": { "canDelete": { "allowed": true, "reason": null }, "canActivateRegistryLock": { "allowed": true, "reason": null }, "canRequestRegistryUnlock": { "allowed": false, "reason": "Registry-lock unlock requests are only available for .se and .nu domains." }, "canRenewNow": { "allowed": true, "reason": null }, "canEditContacts": { "allowed": true, "reason": null }, "canChangeBillingCycle": { "allowed": true, "reason": null }, "canEnableAutoRenew": { "allowed": true, "reason": null }, "canDisableAutoRenew": { "allowed": true, "reason": null, "requiresConfirmation": null } }}Response fields
idstringnamestringserviceStatusstringactive, suspended, terminated, pending, cancelled, expired, fraud, transferred_out, unknown.actionRequiredbooleanGET /api/v2/domains/{id}/lifecycle gives the reason and the way to fix it.awaitingPaymentboolean or nullorderIdstringlifecycleobjecttypestringstandard, registration, transfer and renewal.autoRenewEnabledboolean or nullregistrarLockEnabledboolean or nulltransferInProgressbooleanGET /api/v2/domains/{id}/lifecycle.billingobjectamountnumbercurrencyCode.currencyCodestringbillingCyclestring or nullperiodYears then. One of annually, biennially, triennially.periodYearsinteger or nullinitialAmountnumbercreatedAtstring or nullexpiresAtstring or nullnextDueAtstring or nulltagsarray of stringpinnedbooleancontactDetailsVerificationnullreason (text to show), deadlineAt, renewalBlocked, serviceInterruptionRisk and actions.canUpdateContacts.hostingConnectionobjecttypestringstandalone, hosting, wordpress.hostingAccountIdstring or nullhostingAccountNamestring or nullhostingAccountDomainstring or nullsslobject or nullnameserversarray of stringtransferobjecteppCodestring or nullPOST /api/v2/domains/{id}/actions/request-epp.notesstring or nullpendingRenewalOrdernullpendingDomainOrdernullregistryLockobjectenabledboolean or nullrequiresManualUnlockFlowbooleanunlockActionobject or nullpausedByHostupbooleanrenewalDeadlineAtstring or nullrenewalUnpaidbooleanwhoisPrivacyobjectenabledboolean or nullautoEnablebooleanstatusstringauto_enable_allowed, auto_enable_opted_out.reasonstring or nullupdatedAtstring or nullactionsobjectcanDeleteobjectallowedbooleanreasonstring or nullcodestring or nullcanActivateRegistryLockobjectallowedbooleanreasonstring or nullcodestring or nullcanRequestRegistryUnlockobjectallowedbooleanreasonstring or nullcodestring or nullcanRenewNowobjectPOST /api/v2/domains/{id}/actions/renew can run now. code says why not, for example pending_renewal_order, not_renewable, max_renewal_period_exceeded, renewal_eligibility_unavailable, registry_contact_verification_required or nordic_guard_blocked.allowedbooleanreasonstring or nullcodestring or nullcanEditContactsobjectallowedbooleanreasonstring or nullcodestring or nullcanChangeBillingCycleobjectallowedbooleanreasonstring or nullcodestring or nullcanEnableAutoRenewobjectallowedbooleanreasonstring or nullcodestring or nulldomain_not_active, domain_transferred_out.canDisableAutoRenewobjectallowedbooleanreasonstring or nullcodestring or nullrequiresConfirmationstring or nullcancel_pending_order, registry_lock_removal.Errors
Errors are Problem Details with a stable code. Branch on the code, not on the text.
| 401 | Unauthorized. Authentication is required. |
| 403 | Forbidden. The caller lacks a required scope or does not own the resource. |
| 404 | Not found. The resource does not exist or is not owned by the caller; code is domain_not_found. |
| 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. |