Request removal of a registry lock
POST /api/v2/domains/{id}/actions/request-unlock
Ask Hostup to remove the registry lock from an active .se or .nu domain. Call it when registryLock.unlockAction.href is set on GET /api/v2/domains/{id}. For other domain endings, turn the lock off with registrarLock: false on PATCH /api/v2/domains/{id}. Hostup checks that you may act for the domain holder and then removes the lock by hand. The check needs a client-area login verified with BankID. An API key alone cannot send a new request. status says what happened. When it is verification_failed, verificationReason says why. To send the request for manual review anyway, resend with forceRequest: true.
Authentication: An API key with the scope write:domains. About keys and scopes
Request
Path parameters
idstringrequireddom_…).Body (optional)
forceRequestbooleanverification_failed response. Default false.Example
curl -X POST "https://cloud.hostup.se/api/v2/domains/dom_01hxa3b4c5d6e7f8g9h0j1k2m3/actions/request-unlock" \ -H "Authorization: Bearer $HOSTUP_API_KEY" \ -H "Content-Type: application/json"curl -X POST "https://cloud.hostup.se/api/v2/domains/dom_01hxa3b4c5d6e7f8g9h0j1k2m3/actions/request-unlock" \ -H "Authorization: Bearer $HOSTUP_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "forceRequest": true }'Responses
200 The outcome of the request.
{ "domainId": "dom_01hxa3b4c5d6e7f8g9h0j1k2m3", "status": "submitted", "domainName": "example.se", "domainExtension": null, "ticVerified": true, "verifiedAs": "Styrelseledamot", "companyName": "Example AB", "daysSinceRequest": null, "verificationReason": null, "domainOrgno": null, "yourOrgno": null, "requiresConfirmation": false}Response fields
domainIdstringstatusstringalready_unlocked, already_requested, bankid_required, verification_failed, submitted.domainNamestring or nulldomainExtensionstring or nullbankid_required.ticVerifiedboolean or nullverifiedAsstring or nullcompanyNamestring or nulldaysSinceRequestnumber or nullalready_requested.verificationReasonstring or nullverification_failed.verificationUnavailablebooleanreasonCodestringverificationUnavailable. One of company_lookup_unavailable, company_lookup_rate_limited.retryAfterAtstring or nullverificationUnavailable.domainOrgnostring or nullverification_failed.yourOrgnostring or nullverification_failed.requiresConfirmationbooleanforceRequest: true.Errors
Errors are Problem Details with a stable code. Branch on the code, not on the text.
| 400 | The body is not valid or the domain is not a .se or .nu domain. |
| 401 | Unauthorized. Authentication is required. |
| 403 | Forbidden. The caller lacks a required scope or does not own the resource. |
| 404 | The domain does not exist in your account. |
| 409 | The domain is not active (domain_not_active). serviceStatus gives its status. |
| 429 | Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers. |
| 500 | With an API key, a new request answers internal_error because the request needs a BankID login. Retrying gives the same answer. Send the request from the client area. |