Domain Chief API v1

Schemas

Contact

handlestring · required
company_namestring | null · required
first_namestring · required
last_namestring · required
company_registration_numberstring | null · required
vat_registrationstring | null · required
address_streetstring · required
address_house_numberstring · required
address_postal_codestring · required
address_citystring · required
address_country_codestring · required
Country code in ISO 3166-1 alpha-2 format.
Example: NL
emailstring · required
phonestring · required
Phone numbers are in international format.
Example: +31 20 1234567
email_verification_statusrequired
is_defaultboolean · required
Indicates if the contact is the default contact for the team.
metadataobject · required
Metadata attached to the contact.

ContactEmailVerificationStatus

string · enum

Enum values:

pending

verified


`pending` A verification e-mail has been sent to the email address for verification, waiting on user action.
`verified` The e-mail address is verified.

DNSRecord

idstring · required
typestring · enum · required
Enum values:
A
MX
NS
TXT
SOA
SRV
PTR
CAA
namestring · required
The record name. When empty the record is for the root domain. This never includes the domain name itself.
Example: www
contentstring · required
The record content.
Example: 192.0.2.1
ttlinteger · required
The record TTL.
priointeger · required
The record priority. Only available for certain record types, will always be 0 when not supported and ignored when creating/updating.
metadataobject · required
Metadata attached to the record.

DNSRecordType

string · enum

Enum values:

TXT

SOA

SRV

PTR

CAA

DnssecKey

public_keystring · required
Public key for the DNSSEC key.

algorithminteger · enum · required


`1` RSA/MD5
`2` Diffie-Hellman
`3` DSA/SHA-1
`5` RSA/SHA-1
`6` RSA/SHA-1 NSEC3
`7` RSA/SHA-1 NSEC3 with SHA-1
`8` RSA/SHA-256
`10` RSA/SHA-512
`12` GOST R 34.11-94
`13` ECDSA P-256/SHA-256
`14` ECDSA P-384/SHA-384
`15` Ed25519
`16` Ed448
`17` SM2 with SM3
`23` GOST R 34.10-2001

Enum values:

flagsinteger · enum · required

256
ZSK
257
KSK
Enum values:
256
257
protocolinteger · required
This will always be 3 (DNSSEC).
Example: 3

DnssecKeyAlgorithm

integer · enum

Enum values:


`1` RSA/MD5
`2` Diffie-Hellman
`3` DSA/SHA-1
`5` RSA/SHA-1
`6` RSA/SHA-1 NSEC3
`7` RSA/SHA-1 NSEC3 with SHA-1
`8` RSA/SHA-256
`10` RSA/SHA-512
`12` GOST R 34.11-94
`13` ECDSA P-256/SHA-256
`14` ECDSA P-384/SHA-384
`15` Ed25519
`16` Ed448
`17` SM2 with SM3
`23` GOST R 34.10-2001

DnssecKeyType

integer · enum

Enum values:

256

257


`256` ZSK
`257` KSK

Domain

idstring · required
tldrequired
The top level domain of the domain name, can be expanded.
Example: com
namestring · required
The name of the domain without the top level domain.
Example: example
domainstring · required
The full domain name.
Example: example.nl
typestring · enum · required

new
The domain is newly registered.
transfer
The domain is transfered in.
unknown
It is unknown how the domain ended up here.
Enum values:
new
transfer
unknown

statusstring · enum · required


`active` The domain is registered.
`failed` There was a problem completing the registration or transfer.
`deleted` The domain is deleted (either manually of because it was expired).
`requested` The domain registration or transfer has been requested and is being processed.
`restorable` The domain has been deleted at the registry but is still restorable by the user.

Enum values:

active

failed

deleted

requested

restorable

is_premiumboolean · required
Indicates if the domain is a premium domain which might have a higher price then normal for renewals.
is_lockedboolean | null · required
Indicates if the domain is locked, if locked the domain cannot be transferred to another registrar. Not all domains support locking, in that case (where it's not supported) this value will be null.
is_autorenew_enabledboolean · required
Indicates if the domain is automatically renewed, if not enabled the domain will expire unless manually renewed.
is_whois_privacy_enabledboolean | null · required
Indicates if the domain has WHOIS privacy enabled, when WHOIS privacy is not supported by the TLD this value will be null.
is_using_hosted_dnsboolean · required
Indicates if the domain us using hosted DNS from Domain Chief instead of custom nameservers, this means DNS records can be managed.
is_dnssec_enabledboolean | null · required
Indicates if the domain has DNSSEC enabled, when DNSSEC is not supported by the TLD this value will be null.
dnssec_keysobject[] · required
The list of DNSSEC keys configured for the domain. This list will always be empty when DNSSEC is not supported.
contactsobject · required
List of contacts for the domain, the key is the contact type (see DomainHandleType) and the value is the handle of the contact or if expanded the full contact object.
Example: {"owner":"CHIEF-CT0000-NL","admin":"CHIEF-CT0000-NL","tech":"CHIEF-CT0000-NL"}
nameserversobject[] · required
The list of nameservers configured for the domain name.
nameserver_providerstring · enum · required
Enum values:
custom
alboweb
domainchief
sedo
versio
vimexx
hetzner
route53
renews_atstring | null · date-time · required
The date on which the domain will renew. Can be null if auto-renewal is disabled or the domain is not yet registered.
expires_atstring | null · date-time · required
The date on which the domain will expire if not renewed. Can be null if auto-renewal is enabled or the domain is not yet registered.
renewal_priceinteger · required
The renewal price for this domain, if the domain is a premium domain this is the correct renewal price otherwise this value is the same as tld.renewal_price. The price is in EUR cents and is excluding VAT or other applicable taxes.
Example: 826
metadataobject · required
Metadata attached to the domain.

DomainAvailability

string · enum

Enum values:

free

owned

active

error


`free` Domain is available for registration
`owned` Domain is owned by the authenticated team
`active` Domain is registered, may be transferable
`error` An error has occured retrieving availability

DomainAvailabilityResult

tldrequired
The top level domain of the domain name, can be expanded.
Example: com
namestring · required
The name of the domain without the top level domain.
Example: example
domainstring · required
The full domain name.
Example: example.nl
is_premiumboolean · required
Indicates if the domain is a premium domain which might have a higher price then normal for registration and renewals.
availabilitystring · enum · required

free
Domain is available for registration
owned
Domain is owned by the authenticated team
active
Domain is registered, may be transferable
error
An error has occured retrieving availability
Enum values:
free
owned
active
error
priceinteger | null · required
The price of the domain registration or transfer based on the availability. The price is in EUR cents and is excluding VAT or other applicable taxes.

Only available when the price expansion is requested.
renewal_priceinteger | null · required
The price of subsequent domain renewals after registration or transfer. The price is in EUR cents and is excluding VAT or other applicable taxes.

Only available when the price expansion is requested.
renewal_datestring | null · date-time · required
The date the domain will expire and is expected to be renewed. Only available when the domain is owned by the authenticated team or in some cases when the auth-code was provided.

DomainHandleType

string · enum

Enum values:

tech

owner

admin

billing

reseller

DomainNameserverProvider

string · enum

Enum values:

custom

alboweb

domainchief

sedo

versio

vimexx

hetzner

route53

DomainStatus

string · enum

Enum values:

active

failed

deleted

requested

restorable


`active` The domain is registered.
`failed` There was a problem completing the registration or transfer.
`deleted` The domain is deleted (either manually of because it was expired).
`requested` The domain registration or transfer has been requested and is being processed.
`restorable` The domain has been deleted at the registry but is still restorable by the user.

DomainTransferType

string · enum

Enum values:

unchanged

restart

extend


`unchanged` The current expiration date is kept unchanged on transfer, this usually means the transfer is free.
`restart` The expiration date is reset and any remaining time you might have paid for at the outgoing registrar is lost.
`extend` The expiration date is extended with the time you have paid for at the outgoing registrar + a renewal period (usually 1 year)

DomainType

string · enum

Enum values:

new

transfer

unknown


`new` The domain is newly registered.
`transfer` The domain is transfered in.
`unknown` It is unknown how the domain ended up here.

TLD

namestring · required
The name of the TLD.
Example: eu
handle_typesstring[] · required
Supported domain handle types for this TLD.
Enum values:
tech
owner
admin
billing
reseller

transfer_typestring · enum · required


`unchanged` The current expiration date is kept unchanged on transfer, this usually means the transfer is free.
`restart` The expiration date is reset and any remaining time you might have paid for at the outgoing registrar is lost.
`extend` The expiration date is extended with the time you have paid for at the outgoing registrar + a renewal period (usually 1 year)

Enum values:

unchanged

restart

extend

registration_priceinteger · required
The price for a new domain registration, this is due at the moment you register a new domain name. This price is an indication, the actual price may vary based on the domain name (in case it's considered premium), always use the availability endpoint to ensure the price is what you expect for the exact domain.

The price is in EUR cents and is excluding VAT or other applicable taxes.
Example: 826
renewal_priceinteger · required
The price for renewal of your domain registration, this is due every year. This price is an indication, the actual price may vary based on the domain name (in case it's considered premium), always use the availability endpoint to ensure the price is what you expect for the exact domain.

The price is in EUR cents and is excluding VAT or other applicable taxes.
Example: 826
transfer_priceinteger · required
The price for a transfer of your domain registration from another registrar, this is due at the moment you request a domain transfer. This price is an indication, the actual price may vary based on the domain name (in case it's considered premium), always use the availability endpoint to ensure the price is what you expect for the exact domain.

The price is in EUR cents and is excluding VAT or other applicable taxes.
Example: 826
supports_dnssecboolean · required
Indicates if the TLD supports DNSSEC.
supported_dnssec_algorithmsinteger[] · required
The list of DNSSEC algorithms supported by the TLD.
Enum values:
1
2
3
5
6
7
8
10
Example: [13]
supports_whois_privacyboolean · required
Indicates if the TLD supports WHOIS privacy.

WebRedirect

idstring · required
subdomainstring | null · required
The subdomain being redirected. When the subdomain is null the www subdomain is implied.
nameinteger · required
The status code used for the redirect.
Example: 301
targetstring · required
The target URL of the redirect.
Example: https://example.nl
include_pathboolean · required
Indicates if the path should be appended to the target URL.
include_queryboolean · required
Indicates if the query string should be appended to the target URL.

Domain Chief API v1

Schemas

Contact

handlestring · required
company_namestring | null · required
first_namestring · required
last_namestring · required
company_registration_numberstring | null · required
vat_registrationstring | null · required
address_streetstring · required
address_house_numberstring · required
address_postal_codestring · required
address_citystring · required
address_country_codestring · required
Country code in ISO 3166-1 alpha-2 format.
Example: NL
emailstring · required
phonestring · required
Phone numbers are in international format.
Example: +31 20 1234567
email_verification_statusrequired
is_defaultboolean · required
Indicates if the contact is the default contact for the team.
metadataobject · required
Metadata attached to the contact.

ContactEmailVerificationStatus

string · enum

Enum values:

pending

verified


`pending` A verification e-mail has been sent to the email address for verification, waiting on user action.
`verified` The e-mail address is verified.

DNSRecord

idstring · required
typestring · enum · required
Enum values:
A
MX
NS
TXT
SOA
SRV
PTR
CAA
namestring · required
The record name. When empty the record is for the root domain. This never includes the domain name itself.
Example: www
contentstring · required
The record content.
Example: 192.0.2.1
ttlinteger · required
The record TTL.
priointeger · required
The record priority. Only available for certain record types, will always be 0 when not supported and ignored when creating/updating.
metadataobject · required
Metadata attached to the record.

DNSRecordType

string · enum

Enum values:

TXT

SOA

SRV

PTR

CAA

DnssecKey

public_keystring · required
Public key for the DNSSEC key.

algorithminteger · enum · required


`1` RSA/MD5
`2` Diffie-Hellman
`3` DSA/SHA-1
`5` RSA/SHA-1
`6` RSA/SHA-1 NSEC3
`7` RSA/SHA-1 NSEC3 with SHA-1
`8` RSA/SHA-256
`10` RSA/SHA-512
`12` GOST R 34.11-94
`13` ECDSA P-256/SHA-256
`14` ECDSA P-384/SHA-384
`15` Ed25519
`16` Ed448
`17` SM2 with SM3
`23` GOST R 34.10-2001

Enum values:

flagsinteger · enum · required

256
ZSK
257
KSK
Enum values:
256
257
protocolinteger · required
This will always be 3 (DNSSEC).
Example: 3

DnssecKeyAlgorithm

integer · enum

Enum values:


`1` RSA/MD5
`2` Diffie-Hellman
`3` DSA/SHA-1
`5` RSA/SHA-1
`6` RSA/SHA-1 NSEC3
`7` RSA/SHA-1 NSEC3 with SHA-1
`8` RSA/SHA-256
`10` RSA/SHA-512
`12` GOST R 34.11-94
`13` ECDSA P-256/SHA-256
`14` ECDSA P-384/SHA-384
`15` Ed25519
`16` Ed448
`17` SM2 with SM3
`23` GOST R 34.10-2001

DnssecKeyType

integer · enum

Enum values:

256

257


`256` ZSK
`257` KSK

Domain

idstring · required
tldrequired
The top level domain of the domain name, can be expanded.
Example: com
namestring · required
The name of the domain without the top level domain.
Example: example
domainstring · required
The full domain name.
Example: example.nl
typestring · enum · required

new
The domain is newly registered.
transfer
The domain is transfered in.
unknown
It is unknown how the domain ended up here.
Enum values:
new
transfer
unknown

statusstring · enum · required


`active` The domain is registered.
`failed` There was a problem completing the registration or transfer.
`deleted` The domain is deleted (either manually of because it was expired).
`requested` The domain registration or transfer has been requested and is being processed.
`restorable` The domain has been deleted at the registry but is still restorable by the user.

Enum values:

active

failed

deleted

requested

restorable

is_premiumboolean · required
Indicates if the domain is a premium domain which might have a higher price then normal for renewals.
is_lockedboolean | null · required
Indicates if the domain is locked, if locked the domain cannot be transferred to another registrar. Not all domains support locking, in that case (where it's not supported) this value will be null.
is_autorenew_enabledboolean · required
Indicates if the domain is automatically renewed, if not enabled the domain will expire unless manually renewed.
is_whois_privacy_enabledboolean | null · required
Indicates if the domain has WHOIS privacy enabled, when WHOIS privacy is not supported by the TLD this value will be null.
is_using_hosted_dnsboolean · required
Indicates if the domain us using hosted DNS from Domain Chief instead of custom nameservers, this means DNS records can be managed.
is_dnssec_enabledboolean | null · required
Indicates if the domain has DNSSEC enabled, when DNSSEC is not supported by the TLD this value will be null.
dnssec_keysobject[] · required
The list of DNSSEC keys configured for the domain. This list will always be empty when DNSSEC is not supported.
contactsobject · required
List of contacts for the domain, the key is the contact type (see DomainHandleType) and the value is the handle of the contact or if expanded the full contact object.
Example: {"owner":"CHIEF-CT0000-NL","admin":"CHIEF-CT0000-NL","tech":"CHIEF-CT0000-NL"}
nameserversobject[] · required
The list of nameservers configured for the domain name.
nameserver_providerstring · enum · required
Enum values:
custom
alboweb
domainchief
sedo
versio
vimexx
hetzner
route53
renews_atstring | null · date-time · required
The date on which the domain will renew. Can be null if auto-renewal is disabled or the domain is not yet registered.
expires_atstring | null · date-time · required
The date on which the domain will expire if not renewed. Can be null if auto-renewal is enabled or the domain is not yet registered.
renewal_priceinteger · required
The renewal price for this domain, if the domain is a premium domain this is the correct renewal price otherwise this value is the same as tld.renewal_price. The price is in EUR cents and is excluding VAT or other applicable taxes.
Example: 826
metadataobject · required
Metadata attached to the domain.

DomainAvailability

string · enum

Enum values:

free

owned

active

error


`free` Domain is available for registration
`owned` Domain is owned by the authenticated team
`active` Domain is registered, may be transferable
`error` An error has occured retrieving availability

DomainAvailabilityResult

tldrequired
The top level domain of the domain name, can be expanded.
Example: com
namestring · required
The name of the domain without the top level domain.
Example: example
domainstring · required
The full domain name.
Example: example.nl
is_premiumboolean · required
Indicates if the domain is a premium domain which might have a higher price then normal for registration and renewals.
availabilitystring · enum · required

free
Domain is available for registration
owned
Domain is owned by the authenticated team
active
Domain is registered, may be transferable
error
An error has occured retrieving availability
Enum values:
free
owned
active
error
priceinteger | null · required
The price of the domain registration or transfer based on the availability. The price is in EUR cents and is excluding VAT or other applicable taxes.

Only available when the price expansion is requested.
renewal_priceinteger | null · required
The price of subsequent domain renewals after registration or transfer. The price is in EUR cents and is excluding VAT or other applicable taxes.

Only available when the price expansion is requested.
renewal_datestring | null · date-time · required
The date the domain will expire and is expected to be renewed. Only available when the domain is owned by the authenticated team or in some cases when the auth-code was provided.

DomainHandleType

string · enum

Enum values:

tech

owner

admin

billing

reseller

DomainNameserverProvider

string · enum

Enum values:

custom

alboweb

domainchief

sedo

versio

vimexx

hetzner

route53

DomainStatus

string · enum

Enum values:

active

failed

deleted

requested

restorable


`active` The domain is registered.
`failed` There was a problem completing the registration or transfer.
`deleted` The domain is deleted (either manually of because it was expired).
`requested` The domain registration or transfer has been requested and is being processed.
`restorable` The domain has been deleted at the registry but is still restorable by the user.

DomainTransferType

string · enum

Enum values:

unchanged

restart

extend


`unchanged` The current expiration date is kept unchanged on transfer, this usually means the transfer is free.
`restart` The expiration date is reset and any remaining time you might have paid for at the outgoing registrar is lost.
`extend` The expiration date is extended with the time you have paid for at the outgoing registrar + a renewal period (usually 1 year)

DomainType

string · enum

Enum values:

new

transfer

unknown


`new` The domain is newly registered.
`transfer` The domain is transfered in.
`unknown` It is unknown how the domain ended up here.

TLD

namestring · required
The name of the TLD.
Example: eu
handle_typesstring[] · required
Supported domain handle types for this TLD.
Enum values:
tech
owner
admin
billing
reseller

transfer_typestring · enum · required


`unchanged` The current expiration date is kept unchanged on transfer, this usually means the transfer is free.
`restart` The expiration date is reset and any remaining time you might have paid for at the outgoing registrar is lost.
`extend` The expiration date is extended with the time you have paid for at the outgoing registrar + a renewal period (usually 1 year)

Enum values:

unchanged

restart

extend

registration_priceinteger · required
The price for a new domain registration, this is due at the moment you register a new domain name. This price is an indication, the actual price may vary based on the domain name (in case it's considered premium), always use the availability endpoint to ensure the price is what you expect for the exact domain.

The price is in EUR cents and is excluding VAT or other applicable taxes.
Example: 826
renewal_priceinteger · required
The price for renewal of your domain registration, this is due every year. This price is an indication, the actual price may vary based on the domain name (in case it's considered premium), always use the availability endpoint to ensure the price is what you expect for the exact domain.

The price is in EUR cents and is excluding VAT or other applicable taxes.
Example: 826
transfer_priceinteger · required
The price for a transfer of your domain registration from another registrar, this is due at the moment you request a domain transfer. This price is an indication, the actual price may vary based on the domain name (in case it's considered premium), always use the availability endpoint to ensure the price is what you expect for the exact domain.

The price is in EUR cents and is excluding VAT or other applicable taxes.
Example: 826
supports_dnssecboolean · required
Indicates if the TLD supports DNSSEC.
supported_dnssec_algorithmsinteger[] · required
The list of DNSSEC algorithms supported by the TLD.
Enum values:
1
2
3
5
6
7
8
10
Example: [13]
supports_whois_privacyboolean · required
Indicates if the TLD supports WHOIS privacy.

WebRedirect

idstring · required
subdomainstring | null · required
The subdomain being redirected. When the subdomain is null the www subdomain is implied.
nameinteger · required
The status code used for the redirect.
Example: 301
targetstring · required
The target URL of the redirect.
Example: https://example.nl
include_pathboolean · required
Indicates if the path should be appended to the target URL.
include_queryboolean · required
Indicates if the query string should be appended to the target URL.