Domains

Transfer a domain to Hypamoon

Moves the registration of a domain the user owns to Hypamoon, with the transfer code of the current registrar. accept_registry_terms must be true and max_price_eur is the amount the user confirmed. dns hypamoon switches the nameservers to the zone here when the transfer completes, so it is refused with confirmation_required (nothing charged) while the preflight is not ready, unless ignore_preflight; keep leaves them as they are. Needs an Idempotency-Key; a key whose attempt failed is never retried. 201 when the transfer completes immediately, 202 while it is in progress (follow it with GET /domains/{id}). In live mode the price is deducted from the balance and refunded if the transfer fails. Transfers in live mode are not open yet: until they are, a live key gets service_unavailable, and test mode works as described.

post/domains/transfer

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/domains/transfer
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: sites:write)

Headers

Idempotency-Keystring required

A unique key for this transfer, like a UUID.

Request body

domainstring required

The domain to move to Hypamoon, like example.com.

authcodestring

The transfer code (auth code, EPP code; for .nl the token) the user got from their current registrar. Required for most extensions. Never stored.

accept_registry_termsboolean required

Must be true: the user (the registrant) explicitly accepted the terms of the registry at registry_terms_url from check_domain.

max_price_eurnumber required

The highest amount the user agreed to pay for the transfer. Refused if the price is higher.

dns'hypamoon' | 'keep'

hypamoon (default): the nameservers switch to the DNS zone here when the transfer completes; run preflight_domain first. keep: the nameservers stay as they are; switch later with switch_domain_nameservers.

site_idstring uuid nullable

Optional. A site of this project to serve on the domain once it is active.

dkim_selectorsstring[]

Optional. The DKIM selector(s) of the user's mail provider, so their DKIM records are copied too.

ignore_preflightboolean

Optional, default false. With dns hypamoon the nameservers switch when the transfer completes, so the transfer is refused (confirmation_required, nothing charged) while preflight_domain is not ready. true transfers anyway, only when the user accepts the listed differences.

Response

The transfer completed.

Changes

No recorded changes to this operation across all 1 revision of this API.