Sign in

v1

latestOpenAPI 3.1.12026-07-17111158225.7 KB
registrar

Register a domain

Registers a domain name.

Your account must be active for this command to complete successfully. You will be automatically charged the registration fee upon successful registration, so please be careful with this command.

When registering a domain using Solo or Teams subscription, the DNS services for the zone will be automatically enabled and this will be charged on your following subscription renewal invoices.

post/{account}/registrar/domains/{domain}/registrations

Path parameters

accountinteger required

The account id

domainstring required

The domain name or id

Request body

registrant_idinteger required

The ID of an existing contact in your account.

whois_privacyboolean

Set to true will attempt to purchase/enable the whois privacy as part of the registration. An extra cost may apply. Default: false.

auto_renewboolean

Set to true to enable the auto-renewal of the domain. Default: false.

trusteeboolean

Set to true will attempt to purchase/enable trustee service as part of the registration. An extra cost may apply. Default: false.

extended_attributesobject

Required for TLDs that require extended attributes.

premium_pricestring

Required as confirmation of the price, only if the domain is premium.

linked_providerstring

The nickname of a linked provider to register the domain through. If left blank, registration will go through DNSimple.

Example request

{
  "registrant_id": 1,
  "trustee": true
}

Response

Domain successfully registered

Example response

{
  "data": {
    "id": 1,
    "domain_id": 999,
    "registrant_id": 2,
    "period": 1,
    "state": "new",
    "auto_renew": false,
    "whois_privacy": false,
    "trustee": false,
    "created_at": "2016-12-09T19:35:31Z",
    "updated_at": "2016-12-09T19:35:31Z"
  }
}