Domain Registration

Endpointhttps://domain.chief.app/api/v1

Download schema

Register or transfer domain

POST

https://domain.chief.app/api/v1

/domains

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Validation happens realtime but the actual registration or transfer will be processed asynchronously. Do not consider the domain successfully registered until the status of the domain changes.

This endpoint could result in a charge to the authenticated team's payment method or an invoice being created. Use the .example TLD for testing purposes, these are free to manage.

Register or transfer domain › query Parameters

expand[]

string[]

Expand related resources.

Enum values:

tld

contacts

Register or transfer domain › Request Body

domain

string · minLength: 3 · maxLength: 63 · required

The domain name to register or transfer.

auth_code

string

If you are transferring a domain, you must provide the authorization code if it's required by the registry.

is_using_hosted_dns

boolean

Cannot be enabled when also providing nameservers. If you are not using hosted DNS you must provide at least two nameservers.

is_whois_privacy_enabled

boolean

Enable or disable WHOIS privacy for the domain. This is not supported by all TLDs, check supports_whois_privacy for the TLD first before setting this attribute. Cannot be provided together with contacts.

object

Map of contacts for the domain. If you do not provide a contact type supported by the TLD, the contact will be set to the default contact for the team. When you provide contact handle types that are not supported by the TLD they will be ignored.

Cannot be provided together with is_whois_privacy_enabled.

object

Optional metadata to attach to the domain. Metadata keys must be strings and cannot exceed 40 characters or contain [ or ] characters. Metadata values must be strings and cannot exceed 500 characters. A domain cannot have more than 50 metadata keys.

object[]

DNSSEC keys are not supported by all TLDs, check supports_dnssec for the TLD first before providing this attribute. If you want to enable DNSSEC you need to provide at least one DNSSEC key.

object[] · minItems: 2

Cannot be supplied together with is_using_hosted_dns. You need to provide at least two nameservers.

Register or transfer domain › Responses

Domain

object · required

POST/domains

curl --request POST \
  --url https://domain.chief.app/api/v1/domains \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "domain",
  "auth_code": "auth_code",
  "is_using_hosted_dns": true,
  "is_whois_privacy_enabled": true,
  "contacts": {
    "owner": "owner",
    "admin": "admin",
    "tech": "tech",
    "billing": "billing",
    "reseller": "reseller"
  },
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "dnssec_keys": [
    {
      "public_key": "public_key",
      "algorithm": 1,
      "flags": 256,
      "protocol": "3"
    }
  ],
  "nameservers": [
    {
      "hostname": "ns.domainchief.eu",
      "ipv4": "ipv4",
      "ipv6": "ipv6"
    }
  ]
}
'

shell

Example Request Body

{
  "domain": "domain",
  "auth_code": "auth_code",
  "is_using_hosted_dns": true,
  "is_whois_privacy_enabled": true,
  "contacts": {
    "owner": "owner",
    "admin": "admin",
    "tech": "tech",
    "billing": "billing",
    "reseller": "reseller"
  },
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "dnssec_keys": [
    {
      "public_key": "public_key",
      "algorithm": 1,
      "flags": 256,
      "protocol": "3"
    }
  ],
  "nameservers": [
    {
      "hostname": "ns.domainchief.eu",
      "ipv4": "ipv4",
      "ipv6": "ipv6"
    }
  ]
}

json

Example Responses

{
  "data": {
    "id": "id",
    "tld": "com",
    "name": "example",
    "domain": "example.nl",
    "type": "new",
    "status": "active",
    "is_premium": true,
    "is_locked": true,
    "is_autorenew_enabled": true,
    "is_whois_privacy_enabled": true,
    "is_using_hosted_dns": true,
    "is_dnssec_enabled": true,
    "dnssec_keys": [
      {
        "public_key": "public_key",
        "algorithm": 1,
        "flags": 256,
        "protocol": 3
      }
    ],
    "contacts": {
      "owner": "CHIEF-CT0000-NL",
      "admin": "CHIEF-CT0000-NL",
      "tech": "CHIEF-CT0000-NL"
    },
    "nameservers": [
      {
        "hostname": "hostname",
        "ipv4": "ipv4",
        "ipv6": "ipv6"
      }
    ],
    "nameserver_provider": "custom",
    "renews_at": "2024-08-25T15:00:00Z",
    "expires_at": "2024-08-25T15:00:00Z",
    "renewal_price": 826,
    "metadata": {
      "key": "string"
    }
  }
}

json

application/json

Check domain availability

GET

https://domain.chief.app/api/v1

/domains/availability/{domainName}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Check the availability of a domain name.

Check domain availability › path Parameters

domainName

string · required

Check domain availability › query Parameters

expand[]

string[]

Expand related resources.

Enum values:

tld

price

auth_code

string · minLength: 1

Some registries (.nl for example) allow retrieving more domain information with an auth-code. This can be used to see the current renewal date of a domain before transferring it.

This is optional and should only be provided if the user has the auth-code for the domain and needs to see the extended info.

Check domain availability › Responses

DomainAvailabilityResult

object · required

Domains DNS

POST

https://domain.chief.app/api/v1

/domains

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Validation happens realtime but the actual registration or transfer will be processed asynchronously. Do not consider the domain successfully registered until the status of the domain changes.

This endpoint could result in a charge to the authenticated team's payment method or an invoice being created. Use the .example TLD for testing purposes, these are free to manage.

Register or transfer domain › query Parameters

expand[]

string[]

Expand related resources.

Enum values:

tld

contacts

Register or transfer domain › Request Body

domain

string · minLength: 3 · maxLength: 63 · required

The domain name to register or transfer.

auth_code

string

If you are transferring a domain, you must provide the authorization code if it's required by the registry.

is_using_hosted_dns

boolean

Cannot be enabled when also providing nameservers. If you are not using hosted DNS you must provide at least two nameservers.

is_whois_privacy_enabled

boolean

object

Cannot be provided together with is_whois_privacy_enabled.

object

object[]

DNSSEC keys are not supported by all TLDs, check supports_dnssec for the TLD first before providing this attribute. If you want to enable DNSSEC you need to provide at least one DNSSEC key.

object[] · minItems: 2

Cannot be supplied together with is_using_hosted_dns. You need to provide at least two nameservers.

Register or transfer domain › Responses

Domain

object · required

Check domain availability

GET

https://domain.chief.app/api/v1

/domains/availability/{domainName}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Check the availability of a domain name.

Check domain availability › path Parameters

domainName

string · required

Check domain availability › query Parameters

expand[]

string[]

Expand related resources.

Enum values:

tld

price

auth_code

string · minLength: 1

Some registries (.nl for example) allow retrieving more domain information with an auth-code. This can be used to see the current renewal date of a domain before transferring it.

This is optional and should only be provided if the user has the auth-code for the domain and needs to see the extended info.

Check domain availability › Responses

DomainAvailabilityResult

object · required