Get availability check results
GET /api/v2/domains/availability/{jobId}
Returns the progress and results of an availability check started with POST /api/v2/domains/availability. Use the dcheck_... ID from operation.jobId. operation.pollUrl already points here. A generic job_... or domain bulk dbj_... ID returns 400. While status is processing, data can already hold partial results for names that have finished. Poll until status is completed or failed. A completed check returns data in the same shape as the immediate POST answer. A completed check leaves out names whose extension Hostup does not sell, extensions past the eighth for the same name and names whose check failed. Compare data[].name with the names you sent. Check a missing name again on its own. Prices are in SEK. currencyCode and billing.currencyCode are always SEK. Finished checks are kept for a limited time, and a busy period shortens it. Read the results as soon as status is completed. A check that is no longer kept returns 404 job_not_found. A check started by an account (API key or client-area login) can only be read by that account. Others get 404 job_not_found, and so does a request whose API key is unknown, revoked or lacks read:domains. existingDomainId is filled only for authenticated callers.
Authentication: An API key with the scope read:domains. About keys and scopes
Request
Path parameters
jobIdstringrequiredoperation.jobId. It starts with dcheck_.Query parameters
localestringregistryRequirements, for example en.Example
curl "https://cloud.hostup.se/api/v2/domains/availability/dcheck_01hxa3b4c5d6e7f8g9h0j1k2m3" \ -H "Authorization: Bearer $HOSTUP_API_KEY"Responses
200 The check’s status, with results when there are any.
{ "status": "completed", "data": [ { "name": "example.se", "state": "unavailable", "unknownReason": null, "available": false, "reason": "Domain already registered.", "actions": { "canRegister": { "allowed": false, "reason": "Domain already registered." }, "canTransfer": { "allowed": true, "reason": null } }, "billing": { "amount": 99, "currencyCode": "SEK", "billingCycle": "annually" }, "currencyCode": "SEK", "premium": false, "requiresRegistrarFeeAcceptance": false, "eppRequired": true, "renewalAmount": 169, "supportedRegisterYears": [ 1, 2, 3, 5 ], "supportedTransferYears": [ 1 ], "existingDomainId": null, "existingDomainServiceStatus": null, "registryRequirements": { "registration": [ { "key": "phoneNumber", "label": "Phone number", "required": true, "appliesTo": "register", "registrantType": "any", "allowedCountryCodes": null, "allowedRegistrantTypes": null, "alternativeRequirementKey": null, "acceptedTermsKey": null, "reason": ".se and .nu domains require a registrant phone number before the order can be submitted." }, { "key": "registrationIdentifier", "label": "Personal identity number or organization number", "required": true, "appliesTo": "register", "registrantType": "any", "allowedCountryCodes": null, "allowedRegistrantTypes": null, "alternativeRequirementKey": null, "acceptedTermsKey": null, "reason": ".se and .nu domains require a personal identity number or organization number for the registrant." }, { "key": "acceptedTerms", "label": ".se registration terms", "required": true, "appliesTo": "register", "registrantType": "any", "allowedCountryCodes": null, "allowedRegistrantTypes": null, "alternativeRequirementKey": null, "acceptedTermsKey": "se_registration_terms", "reason": ".se domain registrations require acceptance of the registry registration terms before the order can be submitted." } ], "transfer": [ { "key": "phoneNumber", "label": "Phone number", "required": true, "appliesTo": "transfer", "registrantType": "any", "allowedCountryCodes": null, "allowedRegistrantTypes": null, "alternativeRequirementKey": null, "acceptedTermsKey": null, "reason": ".se and .nu domains require a registrant phone number before the order can be submitted." }, { "key": "registrationIdentifier", "label": "Personal identity number or organization number", "required": true, "appliesTo": "transfer", "registrantType": "any", "allowedCountryCodes": null, "allowedRegistrantTypes": null, "alternativeRequirementKey": null, "acceptedTermsKey": null, "reason": ".se and .nu domains require a personal identity number or organization number for the registrant." }, { "key": "eppCode", "label": "Authorization code", "required": true, "appliesTo": "transfer", "registrantType": "any", "allowedCountryCodes": null, "allowedRegistrantTypes": null, "alternativeRequirementKey": null, "acceptedTermsKey": null, "reason": "Transfers for this domain extension require an authorization code from the current provider." } ], "countryEligibility": { "required": false, "allowedCountryCodes": null, "reason": null } } } ]}{ "status": "processing", "progress": 20}{ "status": "processing", "progress": 55, "data": [ { "name": "example.com", "state": "available", "unknownReason": null, "available": true, "reason": null, "actions": { "canRegister": { "allowed": true, "reason": null }, "canTransfer": { "allowed": false, "reason": "Domain is available for registration, not transfer." } }, "billing": { "amount": 159, "currencyCode": "SEK", "billingCycle": "annually" }, "currencyCode": "SEK", "premium": false, "requiresRegistrarFeeAcceptance": false, "eppRequired": false, "renewalAmount": 189, "supportedRegisterYears": [ 1 ], "supportedTransferYears": [ 1 ], "existingDomainId": null, "existingDomainServiceStatus": null, "registryRequirements": { "registration": [], "transfer": [], "countryEligibility": { "required": false, "allowedCountryCodes": null, "reason": null } } } ]}{ "status": "failed", "reason": "The availability check could not be completed."}Response fields
statusstringprocessing: poll again. completed: data holds the results. failed: no name could be checked and reason says so. Start a new check. One of processing, completed, failed.progressnumberstatus is processing.dataarray of objectstatus is completed. While status is processing, the names that are done. Left out until the first one is.namestringstatestringavailable or reason. unknown: the check could not finish. The name is not confirmed taken. Don’t show it as unavailable. already_owned: the name is already registered with Hostup. checking: the check is still running. invalid: the input is not a domain name that can be checked. One of available, unavailable, unknown, already_owned, checking, invalid.unknownReasonstring or nullstate is unknown. null for every other state. One of upstream_timeout, upstream_unavailable.availablebooleanreasonstring or nullactionsobjectcanRegisterobjectallowedbooleanreasonstring or nullnull when it can.canTransferobjectallowedbooleanreasonstring or nullnull when it can.billingobject | nullnull when the check returned no usable registration price.amountnumbercurrencyCodestringbillingCyclestringcurrencyCodestringrenewalAmount and the other prices at the top level. The same as billing.currencyCode when billing is set.premiumbooleanrequiresRegistrarFeeAcceptancebooleaneppRequiredbooleanrenewalAmountnumber or nullcurrencyCode, when known.supportedRegisterYearsarray of integersupportedTransferYearsarray of integerexistingDomainIdstring or nulldom_…) when you already own this name. Otherwise null.existingDomainServiceStatusstring or nullregistryRequirementsobjectregistrationarray of objectkeystringeppCode, phoneNumber, registrationIdentifier, companyRegistrationNumber, birthDate, registrantCountry, registrantType, useDomicile, acceptedTerms, nameservers.labelstringrequiredbooleanappliesTostringregister in registration[], transfer in transfer[]. One of register, transfer, both.registrantTypestringany, private, organisation.allowedCountryCodesarray of any or nullallowedRegistrantTypesarray of any or nullalternativeRequirementKeystring or nullacceptedTermsKeystring or nullreasonstringtransferarray of objectkeystringeppCode, phoneNumber, registrationIdentifier, companyRegistrationNumber, birthDate, registrantCountry, registrantType, useDomicile, acceptedTerms, nameservers.labelstringrequiredbooleanappliesTostringregister in registration[], transfer in transfer[]. One of register, transfer, both.registrantTypestringany, private, organisation.allowedCountryCodesarray of any or nullallowedRegistrantTypesarray of any or nullalternativeRequirementKeystring or nullacceptedTermsKeystring or nullreasonstringcountryEligibilityobjectreasonstringstatus is failed.Errors
Errors are Problem Details with a stable code. Branch on the code, not on the text.
| 400 | The ID is a generic job_... or domain bulk dbj_... ID, not an availability check ID. |
| 404 | No check has this ID. A check that belongs to another account answers the same. |
| 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. |