Schemas

Download schema

Contact

handle

string · required

required

The parent contact of this contact. When expanded, contains the full contact object.

company_name

string | null · required

first_name

string · required

last_name

string · required

company_registration_number

string | null · required

company_trading_name

string | null · required

company_url

string | null · required

vat_registration

string | null · required

address_street

string · required

address_house_number

string · required

address_postal_code

string · required

address_city

string · required

address_state

string | null · required

State or province abbreviation. Only present for countries that have states/provinces (e.g. US, CA).

address_state_name

string | null · required

Full state or province name. Only present when address_state is set.

address_country_code

string · required

Country code in ISO 3166-1 alpha-2 format.

Example: NL

email

string · required

phone

string · required

Phone numbers are in international format.

Example: +31 20 1234567

object · required

TLD-specific extension data.

is_default

boolean · required

Indicates if the contact is the default contact for the team.

object · required

Metadata attached to the contact.

ContactApplicantPurpose

string


`P1` Business use for profit
`P2` Non-profit business, club, association, religious organization, etc.
`P3` Personal use
`P4` Educational purposes
`P5` Government purposes

ContactNexusCategory

string


`C11` US citizen
`C12` Permanent resident of the US
`C21` US organization
`C31` Foreign entity doing business in the US
`C32` Foreign entity with US presence

DNSRecord

id

string · required

type

DNSRecordType · required

The record type.


`A` Maps a name to an IPv4 address.
`MX` Directs email to a mail server, using a priority value.
`NS` Delegates a name or subdomain to an authoritative nameserver.
`TXT` Stores arbitrary text, commonly used for verification and email policies.
`SOA` Contains the zone's authority and timing metadata.
`SRV` Locates a service using priority, weight, port, and target values.
`PTR` Maps an address in a reverse DNS zone to a hostname.
`CAA` Specifies which certificate authorities may issue certificates for the domain.
`TLSA` Associates a TLS service with a certificate or public key.
`AAAA` Maps a name to an IPv6 address.
`CNAME` Makes a name an alias of another hostname.
`ALIAS` Creates a provider-managed alias that behaves like an address record.

Example: A

name

string · required

The record name. When empty the record is for the root domain. This never includes the domain name itself.

Example: www

content

string · required

The record content.

Example: 192.0.2.1

ttl

integer · required

The record TTL in seconds.

prio

integer · required

The record priority. Only available for certain record types, will always be 0 when not supported and ignored when creating/updating.

comment

string | null · required

An optional comment for the record.

sync_error

string | null · required

The latest hosted DNS sync error for this record, if any.

sync_error_at

string | null · required

The ISO-8601 timestamp when the latest hosted DNS sync error was recorded.

object · required

Metadata attached to the record.

DNSRecordImportBlockerCode

string

Identifies why a DNS import cannot be applied. Branch on this value instead of the human-readable message. More values may be added, so clients should handle unknown codes with a generic fallback.


`redirects` The import would remove DNS records used by one or more active Domain Chief web redirects.
`mail_forwarding` The import would remove DNS records used by active Domain Chief mail forwarding.

DNSRecordImportMode

string


`replace` Replace the current zone with the imported records.
`merge` Keep non-conflicting records and replace only records that conflict with the import.

DNSRecordImportPlan

source_domain

string · required

The zone name used to interpret relative record names in the imported data.

destination_domain

string · required

The hosted DNS domain targeted by the import.

mode

DNSRecordImportMode · required

The requested import behavior.


`replace` Replace the current zone with the imported records.
`merge` Keep non-conflicting records and replace only records that conflict with the import.

fingerprint

string · required

An opaque identifier for this imported data and the current destination zone.

object[] · required

DNS records the import would add.

object[] · required

DNS records the import would remove.

object[] · required

Existing DNS records the import would leave unchanged.

object[] · required

Conflicts that must be resolved before the import can be applied. The code is stable for client-side handling; the message is fallback display text.

DNSRecordType

string


`A` Maps a name to an IPv4 address.
`MX` Directs email to a mail server, using a priority value.
`NS` Delegates a name or subdomain to an authoritative nameserver.
`TXT` Stores arbitrary text, commonly used for verification and email policies.
`SOA` Contains the zone's authority and timing metadata.
`SRV` Locates a service using priority, weight, port, and target values.
`PTR` Maps an address in a reverse DNS zone to a hostname.
`CAA` Specifies which certificate authorities may issue certificates for the domain.
`TLSA` Associates a TLS service with a certificate or public key.
`AAAA` Maps a name to an IPv6 address.
`CNAME` Makes a name an alias of another hostname.
`ALIAS` Creates a provider-managed alias that behaves like an address record.

DNSSECKey

public_key

string · required

Public key for the DNSSEC key.

algorithm

DNSSECKeyAlgorithm · required

Algorithm used for the DNSSEC key. Not all algorithms are supported by all TLDs.


`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

flags

DNSSECKeyType · required

Flags for the DNSSEC key. 257 for KSK and 256 for ZSK.


`256` ZSK
`257` KSK

protocol

integer · required

This will always be 3 (DNSSEC).

Example: 3

DNSSECKeyAlgorithm

integer


`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


`256` ZSK
`257` KSK

DNSZoneSnapshot

id

string · required

kind

DNSZoneSnapshotKind · required

Whether Domain Chief or a user saved the snapshot.


`automatic` Saved automatically before a DNS change.
`manual` Saved manually and retained until it is deleted.

required

name

string | null · required

The user-supplied name of a manual snapshot.

display_name

string · required

A ready-to-display name for the snapshot.

DomainActivityCauser · required

The entity that saved the snapshot.

record_count

integer · required

The number of DNS records stored in the snapshot.

created_at

string · date-time · required

The ISO-8601 timestamp when the snapshot was saved.

DNSZoneSnapshotRecord[] · required

Every DNS record stored in the snapshot.

DNSZoneSnapshotKind

string


`automatic` Saved automatically before a DNS change.
`manual` Saved manually and retained until it is deleted.

DNSZoneSnapshotReason

string


`record_created` Captured before a DNS record was created.
`record_updated` Captured before a DNS record was updated.
`record_deleted` Captured before a DNS record was deleted.
`bulk_ttl` Captured before all DNS record TTLs were changed.
`import` Captured before DNS records were imported.
`copy` Captured before DNS records were copied from another zone.
`reset` Captured before DNS records were reset to their defaults.
`clear` Captured before all DNS records were cleared.
`restore` Captured before another DNS snapshot was restored.
`domain_connect` Captured before authorized Domain Connect changes were applied.
`web_redirect` Captured before DNS records for a web redirect were changed.
`mail_forward` Captured before DNS records for mail forwarding were changed.
`initial` Captured when DNS History was introduced for the zone.
`scheduled_change` Captured before a scheduled DNS change was applied.

DNSZoneSnapshotRecord

type

DNSRecordType · required


`A` Maps a name to an IPv4 address.
`MX` Directs email to a mail server, using a priority value.
`NS` Delegates a name or subdomain to an authoritative nameserver.
`TXT` Stores arbitrary text, commonly used for verification and email policies.
`SOA` Contains the zone's authority and timing metadata.
`SRV` Locates a service using priority, weight, port, and target values.
`PTR` Maps an address in a reverse DNS zone to a hostname.
`CAA` Specifies which certificate authorities may issue certificates for the domain.
`TLSA` Associates a TLS service with a certificate or public key.
`AAAA` Maps a name to an IPv6 address.
`CNAME` Makes a name an alias of another hostname.
`ALIAS` Creates a provider-managed alias that behaves like an address record.

name

string · required

The record name without the domain name. An empty value represents the zone root.

content

string · required

The record content in the same form used by the DNS record API.

ttl

integer · required

The record TTL in seconds.

prio

integer · required

The record priority.

comment

string | null · required

The optional record comment.

object · required

DNSZoneSnapshotRecordChange

DNSZoneSnapshotRecord · required

The current DNS record.

DNSZoneSnapshotRecord · required

The DNS record stored in the snapshot.

DNSZoneSnapshotRestorePlan

snapshot_id

string · required

The snapshot that would be restored.

fingerprint

string · required

An opaque identifier for this snapshot and the current hosted DNS zone.

DNSZoneSnapshotRecord[] · required

DNS records the restore would add.

DNSZoneSnapshotRecord[] · required

DNS records the restore would remove.

DNSZoneSnapshotRecordChange[] · required

Existing DNS records the restore would change.

DNSZoneSnapshotRecord[] · required

Existing DNS records that already match the snapshot.

DNSZoneSnapshotSummary

id

string · required

kind

DNSZoneSnapshotKind · required

Whether Domain Chief or a user saved the snapshot.


`automatic` Saved automatically before a DNS change.
`manual` Saved manually and retained until it is deleted.

required

name

string | null · required

The user-supplied name of a manual snapshot.

display_name

string · required

A ready-to-display name for the snapshot.

DomainActivityCauser · required

The entity that saved the snapshot.

record_count

integer · required

The number of DNS records stored in the snapshot.

created_at

string · date-time · required

The ISO-8601 timestamp when the snapshot was saved.

Domain

id

string · required

name

string · required

The name of the domain without the top level domain.

Example: example

required

The top level domain of the domain name, can be expanded.

Example: com

domain

string · required

The full domain name.

Example: example.nl

type

DomainType · required

Indicates if the domain is a new registration or a transfer.


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

status

DomainStatus · required

The status of the domain. Most domain actions will be unavailable when the domain is not active.


`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.
`pending_payment` The domain registration or transfer is waiting for payment before it is processed.
`scheduled` The domain transfer has been scheduled but has not been requested at the registry yet.
`restorable` The domain has been deleted at the registry but is still restorable by the user.

is_premium

boolean · required

Indicates if the domain is a premium domain which might have a higher price then normal for renewals.

is_locked

boolean | 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_enabled

boolean · required

Indicates if the domain is automatically renewed, if not enabled the domain will expire unless manually renewed.

is_whois_privacy_enabled

boolean | 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_dns

boolean · 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_enabled

boolean | null · required

Indicates if the domain has DNSSEC enabled, when DNSSEC is not supported by the TLD this value will be null.

object · 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"}

DNSSECKey[] · required

The list of DNSSEC keys configured for the domain. This list will always be empty when DNSSEC is not supported.

object[] · required

The list of nameservers configured for the domain name.

nameserver_provider

DomainNameserverProvider · required

The detected nameserver provider for the domain, this is based on the nameservers configured.


`custom` The nameservers do not match a recognized provider.
`alboweb` The nameservers are provided by Alboweb.
`domainchief` The nameservers use Domain Chief hosted DNS.
`sedo` The nameservers are provided by Sedo.
`versio` The nameservers are provided by Versio.
`vimexx` The nameservers are provided by Vimexx.
`cloudns` The nameservers are provided by ClouDNS.
`hetzner` The nameservers are provided by Hetzner.
`route53` The nameservers are provided by Amazon Route 53.
`transip` The nameservers are provided by TransIP.
`sectigo` The nameservers are provided by Sectigo.
`webmedia` The nameservers are provided by Webmedia - Nijmegen.
`spaceship` The nameservers are provided by Spaceship.
`nameshift` The nameservers are provided by Nameshift.
`cloudflare` The nameservers are provided by Cloudflare.
`dnsmanager` The nameservers are provided by dnsmanager.io.
`digitalocean` The nameservers are provided by DigitalOcean.
`openprovider` The nameservers are provided by Openprovider.

intended_use

string | null · required

The customer-supplied description of how the domain will be used when required by the registry.

renews_at

string | 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_at

string | 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_price

integer · 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

mail_forward_status

MailForwardingStatus · required

The current mail-forwarding lifecycle status for the domain.


`disabled` The mail forward feature is disabled / not setup.
`pending` The mail forward feature is provisioned and waiting for verification.
`active` The mail forward feature is enabled and active (DNS configured correctly).
`failed` We could not verify the mail forward feature (DNS records possibly not configured correctly).

mail_forward_renews_at

string | null · date-time · required

The date on which mail forwarding will renew. This remains set when forwarding is disabled during a paid period.

scheduled_transfer_at

string | null · date-time · required

The date and time at which a scheduled incoming transfer will be requested.

scheduled_transfer_locks_at

string | null · date-time · required

The date and time after which the transfer schedule can no longer be moved or cancelled.

object · required

Metadata attached to the domain.

DomainNotice[]

Current actionable conditions and operational updates for this domain. A domain can have multiple notices at once, for example contact verification together with a scheduled transfer. Singular domain responses include notices automatically. Domain collections omit them unless requested with expand[]=notices. Treat code, type, severity, actions, and data as the integration contract; message is display copy. New notice codes, actions, and data fields may be added, so clients should ignore values they do not yet support.

DomainActivity

id

string · required

event

DomainActivityEvent · required

The event this activity represents.


`domain.registration.requested` Domain registration was requested. This event is billable.
`domain.registration.request_cancelled` Domain registration request was cancelled before it was sent to the registrar.
`domain.registration.succeeded` Domain registration succeeded. Domain is now registered at the registry and manageable within Domain Chief.
`domain.registration.failed` Domain registration failed. Domain is not registered at the registry and can possibly be retried.
`domain.registration.retry_requested` Domain registration retry was requested.
`domain.transfer.incoming.requested` Domain transfer was requested. This event is billable.
`domain.transfer.incoming.request_cancelled` Domain transfer request was cancelled before it was sent to the registrar.
`domain.transfer.incoming.succeeded` Domain transfer succeeded. Domain is now transfered at the registry and manageable within Domain Chief.
`domain.transfer.incoming.failed` Domain transfer failed. Domain is not transfered at the registry and can possibly be retried.
`domain.transfer.incoming.retry_requested` Domain transfer retry was requested.
`domain.transfer.incoming.scheduled` Domain transfer was scheduled for a future moment.
`domain.transfer.incoming.schedule_moved` Domain transfer schedule was moved to a new future moment.
`domain.transfer.incoming.schedule_cancelled` Domain transfer schedule was cancelled.
`domain.transfer.outgoing.requested` Domain transfer out was requested by another registrar and can be accepted or rejected by the owner.
`domain.transfer.outgoing.succeeded` Domain transfer out succeeded. Domain is now transfered out at the registry and no longer manageable within Domain Chief.
`domain.transfer.outgoing.accepted` Domain transfer out was accepted.
`domain.transfer.outgoing.rejected` Domain transfer out was rejected.
`domain.transfer.outgoing.cancelled` Domain transfer out was cancelled.
`domain.transfer.push.requested` Domain push transfer (tag change) was requested to transfer the domain to another registrar.
`domain.transfer.push.failed` Domain push transfer (tag change) failed at the registry.
`domain.transfer.push.rejected` Domain push transfer (tag change) was rejected by the receiving registrar.
`domain.renewal.succeeded` Domain renewal succeeded. Domain expiry date has been extended at the registry. This event is billable.
`domain.payment.received` Payment for a pending domain operation was received.
`domain.delete.requested` Domain deletion was requested and will be sent to the registry asynchronously.
`domain.delete.failed` Domain deletion failed at the registry. Domain is still active.
`domain.deleted` Domain was deleted at the registry and is no longer manageable within Domain Chief.
`domain.expired` Domain was marked as expired, domain is still restorable until deletion at the registry.
`domain.restore.requested` Domain restoration was requested and will be sent to the registry asynchronously.
`domain.restore.succeeded` Domain was restored at the registry and is manageable within Domain Chief again. This event is billable.
`domain.restore.failed` Domain restoration failed at the registry. Domain is still restorable if the restore period has not ended.
`domain.update.nameservers` Domain nameservers were updated (can include old and new values).
`domain.update.nameservers_failed` A requested nameserver update was rejected by the registry and the confirmed nameservers were restored.
`domain.update.lock_enabled` Domain transfer lock was enabled.
`domain.update.lock_disabled` Domain transfer lock was disabled.
`domain.update.lock_failed` A requested domain transfer lock update was rejected and the confirmed setting was restored.
`domain.update.whois_privacy_enabled` Domain WHOIS privacy was enabled.
`domain.update.whois_privacy_disabled` Domain WHOIS privacy was disabled.
`domain.update.whois_privacy_failed` A requested WHOIS privacy update was rejected and the confirmed setting was restored.
`domain.update.auto_renew_enabled` Domain auto-renewal was enabled.
`domain.update.auto_renew_disabled` Domain auto-renewal was disabled.
`domain.update.auto_renew_failed` A requested auto-renewal update was rejected and the confirmed setting was restored.
`domain.update.contacts` Domain contacts were updated (can include old and new values).
`domain.update.contacts_failed` A requested contact update was rejected and the confirmed contacts were restored.
`domain.update.contacts_and_whois_privacy_failed` A combined contact and WHOIS privacy update was rejected and the confirmed state was restored.
`domain.update.dnssec_keys` Domain DNSSEC keys were updated (can include old and new values).
`domain.update.dnssec_enabled` Domain DNSSEC was enabled.
`domain.update.dnssec_disabled` Domain DNSSEC was disabled.
`domain.update.dnssec_failed` A requested DNSSEC update was rejected by the registry and the confirmed DNSSEC state was restored.
`domain.update.hosted_dns_enabled` Domain hosted DNS was enabled.
`domain.update.hosted_dns_disabled` Domain hosted DNS was disabled.
`domain.update.hosted_dns_sync_failed` One or more hosted DNS records failed to sync upstream.
`domain.update.hosted_dns_restored` Hosted DNS records were restored from DNS history.
`domain.dns.scheduled_change.created` A hosted DNS change was scheduled.
`domain.dns.scheduled_change.revised` A pending scheduled hosted DNS change was revised.
`domain.dns.scheduled_change.cancelled` A pending scheduled hosted DNS change was cancelled.
`domain.dns.scheduled_change.applied` A scheduled hosted DNS change was accepted by the provider.
`domain.dns.scheduled_change.conflicted` A scheduled hosted DNS change was stopped because affected records drifted.
`domain.dns.scheduled_change.superseded` A locally applied scheduled hosted DNS change was replaced before publication completed.
`domain.dns.scheduled_change.publish_failed` A locally applied scheduled hosted DNS change could not be published.
`domain.mail_forward.renewed` Domain mail forwarding was renewed for another billing period. This event is billable.
`domain.mail_forward.enabled` Domain mail forwarding was enabled. This event is billable.
`domain.mail_forward.disabled` Domain mail forwarding was disabled.
`domain.transfer.internal` Domain was transferred between providers within Domain Chief, this event is purely informational.
`domain.contact_verification.required` Domain contact verification was requested for the registrant contact, this is required by some registries after domain registration or transfer.
`domain.contact_verification.approved` Domain contact verification was approved for the registrant contact.
`domain.imported` Domain was created outside Domain Chief and imported to be managed, no prior history is available.

description

string · required

A textual description of this activity.

DomainActivityCauser · required

The entity that caused this activity.

DomainActivitySubject · required

The subject this activity is related to.

DomainActivityProperties · required

Additional properties related to this activity. Domain registrations and transfers may include price and premium indicator for example.

created_at

string | null · date-time · required

The date and time this activity occured.

required

The domain this activity is related to. If the domain relation is expanded, this will be a full Domain resource. Otherwise, it will be the domain's ID. When expanded, the current user must be authorized to view the domain; otherwise, null will be returned (this can happen for deleted domains for example).

cursor

string | null · required

Cursor for pagination. Pass this value to the cursor query parameter to paginate after this activity.

DomainActivityCauser

id

string | null · required

The unique identifier of the causer. When the causer is the API this field contains the ID of the authorising user or the slug of the authorising team.

type

DomainActivityCauserType · required

The type of the causer.


`api` The activity was caused by a request to the API. This might be authorised by a user, team or OAuth token.
`user` The activity was caused by a user.
`team` The activity was caused by a team.
`system` The activity was caused by the system itself.
`registry` The activity was caused by the registry.
`contact` The activity was caused by a contact (e.g. via the public contact validation page).
`deleted` The activity was caused by a deleted user or team.

name

string · required

The name of the causer. This can be the name of the user, team or token.

DomainActivityCauserType

string


`api` The activity was caused by a request to the API. This might be authorised by a user, team or OAuth token.
`user` The activity was caused by a user.
`team` The activity was caused by a team.
`system` The activity was caused by the system itself.
`registry` The activity was caused by the registry.
`contact` The activity was caused by a contact (e.g. via the public contact validation page).
`deleted` The activity was caused by a deleted user or team.

DomainActivityEvent

string


`domain.registration.requested` Domain registration was requested. This event is billable.
`domain.registration.request_cancelled` Domain registration request was cancelled before it was sent to the registrar.
`domain.registration.succeeded` Domain registration succeeded. Domain is now registered at the registry and manageable within Domain Chief.
`domain.registration.failed` Domain registration failed. Domain is not registered at the registry and can possibly be retried.
`domain.registration.retry_requested` Domain registration retry was requested.
`domain.transfer.incoming.requested` Domain transfer was requested. This event is billable.
`domain.transfer.incoming.request_cancelled` Domain transfer request was cancelled before it was sent to the registrar.
`domain.transfer.incoming.succeeded` Domain transfer succeeded. Domain is now transfered at the registry and manageable within Domain Chief.
`domain.transfer.incoming.failed` Domain transfer failed. Domain is not transfered at the registry and can possibly be retried.
`domain.transfer.incoming.retry_requested` Domain transfer retry was requested.
`domain.transfer.incoming.scheduled` Domain transfer was scheduled for a future moment.
`domain.transfer.incoming.schedule_moved` Domain transfer schedule was moved to a new future moment.
`domain.transfer.incoming.schedule_cancelled` Domain transfer schedule was cancelled.
`domain.transfer.outgoing.requested` Domain transfer out was requested by another registrar and can be accepted or rejected by the owner.
`domain.transfer.outgoing.succeeded` Domain transfer out succeeded. Domain is now transfered out at the registry and no longer manageable within Domain Chief.
`domain.transfer.outgoing.accepted` Domain transfer out was accepted.
`domain.transfer.outgoing.rejected` Domain transfer out was rejected.
`domain.transfer.outgoing.cancelled` Domain transfer out was cancelled.
`domain.transfer.push.requested` Domain push transfer (tag change) was requested to transfer the domain to another registrar.
`domain.transfer.push.failed` Domain push transfer (tag change) failed at the registry.
`domain.transfer.push.rejected` Domain push transfer (tag change) was rejected by the receiving registrar.
`domain.renewal.succeeded` Domain renewal succeeded. Domain expiry date has been extended at the registry. This event is billable.
`domain.payment.received` Payment for a pending domain operation was received.
`domain.delete.requested` Domain deletion was requested and will be sent to the registry asynchronously.
`domain.delete.failed` Domain deletion failed at the registry. Domain is still active.
`domain.deleted` Domain was deleted at the registry and is no longer manageable within Domain Chief.
`domain.expired` Domain was marked as expired, domain is still restorable until deletion at the registry.
`domain.restore.requested` Domain restoration was requested and will be sent to the registry asynchronously.
`domain.restore.succeeded` Domain was restored at the registry and is manageable within Domain Chief again. This event is billable.
`domain.restore.failed` Domain restoration failed at the registry. Domain is still restorable if the restore period has not ended.
`domain.update.nameservers` Domain nameservers were updated (can include old and new values).
`domain.update.nameservers_failed` A requested nameserver update was rejected by the registry and the confirmed nameservers were restored.
`domain.update.lock_enabled` Domain transfer lock was enabled.
`domain.update.lock_disabled` Domain transfer lock was disabled.
`domain.update.lock_failed` A requested domain transfer lock update was rejected and the confirmed setting was restored.
`domain.update.whois_privacy_enabled` Domain WHOIS privacy was enabled.
`domain.update.whois_privacy_disabled` Domain WHOIS privacy was disabled.
`domain.update.whois_privacy_failed` A requested WHOIS privacy update was rejected and the confirmed setting was restored.
`domain.update.auto_renew_enabled` Domain auto-renewal was enabled.
`domain.update.auto_renew_disabled` Domain auto-renewal was disabled.
`domain.update.auto_renew_failed` A requested auto-renewal update was rejected and the confirmed setting was restored.
`domain.update.contacts` Domain contacts were updated (can include old and new values).
`domain.update.contacts_failed` A requested contact update was rejected and the confirmed contacts were restored.
`domain.update.contacts_and_whois_privacy_failed` A combined contact and WHOIS privacy update was rejected and the confirmed state was restored.
`domain.update.dnssec_keys` Domain DNSSEC keys were updated (can include old and new values).
`domain.update.dnssec_enabled` Domain DNSSEC was enabled.
`domain.update.dnssec_disabled` Domain DNSSEC was disabled.
`domain.update.dnssec_failed` A requested DNSSEC update was rejected by the registry and the confirmed DNSSEC state was restored.
`domain.update.hosted_dns_enabled` Domain hosted DNS was enabled.
`domain.update.hosted_dns_disabled` Domain hosted DNS was disabled.
`domain.update.hosted_dns_sync_failed` One or more hosted DNS records failed to sync upstream.
`domain.update.hosted_dns_restored` Hosted DNS records were restored from DNS history.
`domain.dns.scheduled_change.created` A hosted DNS change was scheduled.
`domain.dns.scheduled_change.revised` A pending scheduled hosted DNS change was revised.
`domain.dns.scheduled_change.cancelled` A pending scheduled hosted DNS change was cancelled.
`domain.dns.scheduled_change.applied` A scheduled hosted DNS change was accepted by the provider.
`domain.dns.scheduled_change.conflicted` A scheduled hosted DNS change was stopped because affected records drifted.
`domain.dns.scheduled_change.superseded` A locally applied scheduled hosted DNS change was replaced before publication completed.
`domain.dns.scheduled_change.publish_failed` A locally applied scheduled hosted DNS change could not be published.
`domain.mail_forward.renewed` Domain mail forwarding was renewed for another billing period. This event is billable.
`domain.mail_forward.enabled` Domain mail forwarding was enabled. This event is billable.
`domain.mail_forward.disabled` Domain mail forwarding was disabled.
`domain.transfer.internal` Domain was transferred between providers within Domain Chief, this event is purely informational.
`domain.contact_verification.required` Domain contact verification was requested for the registrant contact, this is required by some registries after domain registration or transfer.
`domain.contact_verification.approved` Domain contact verification was approved for the registrant contact.
`domain.imported` Domain was created outside Domain Chief and imported to be managed, no prior history is available.

DomainActivityProperties

price

integer | null

Billable amount in EUR cents.

premium

boolean

Whether the billable operation involved premium registry pricing.

registry_message

string

Sanitized display message returned by the registrar.

object

Persisted immutable cause for a failed domain operation. Omitted when no cause was captured, including for legacy activities.

operation_id

string

Domain operation identifier associated with this activity.

rollback

boolean

Whether this event describes state restored after a rejected registry update.

object

Previous values for supported update events.

object

New values for supported update events.

DomainActivitySubject

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, type, name +1 more
	type = object · requires: id, type, name +1 more

Properties for Variant 1:

id

string · required

The unique identifier of the subject.

type

DomainActivitySubjectType · required


`domain` The activity subject is a domain.

name

string · required

The name of the subject.

permalink

string · required

DomainActivitySubjectType

string


`domain` The activity subject is a domain.

DomainAvailability

string


`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

required

The top level domain of the domain name, can be expanded.

Example: com

name

string · required

The name of the domain without the top level domain.

Example: example

domain

string · required

The full domain name.

Example: example.nl

is_premium

boolean · required

Indicates if the domain is a premium domain which might have a higher price then normal for registration and renewals.

availability

DomainAvailability · required

The availability of the domain.


`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

price

integer | 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_price

integer | 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.

is_converted_currency

boolean | null · required

Indicates if the prices are converted to EUR. When true, the prices returned are converted to EUR using the current exchange rate which means they might fluctuate based on the current exchange rate.

Only available when the price expansion is requested.

renewal_date

string | 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.

DomainContactVerificationContext

string

Describes where the required contact verification sits in the domain lifecycle.


`contact_update` Updated registrant details must be verified before the contact change is sent to the registry.
`requested_domain_operation` A requested registration or incoming transfer is paused until the registrant is verified.
`active_domain` The domain already exists at the registry, but registry verification is still required and DNS resolution may be restricted.

DomainFailureCause

string

Domain operation failure classification captured when a registration or incoming transfer fails.


`authorization_code_incorrect` The supplied transfer authorization code was rejected.
`transfer_locked` The current registrar still has a transfer lock enabled.
`invalid_nameservers` The registry rejected the submitted authoritative nameserver configuration.
`subordinate_nameserver_registrar_mismatch` A subordinate nameserver must be created by the registrar managing its parent domain.
`nameserver_parent_domain_missing` The registry could not find the parent domain for a submitted nameserver.
`registrant_contact_invalid` The registry rejected one or more customer-managed registrant details.
`registrant_ineligible` The registrant does not meet the registry's eligibility or local-presence requirements.
`registry_agreement_required` A registry agreement required for the registration has not been accepted.
`registrar_configuration_invalid` The registrar configuration required by the registry is incomplete or invalid.
`unknown` The failure could not be safely classified; use the notice actions instead of inferring from its message.

DomainHandleType

string


`owner` The owner or registrant of the domain.
`admin` The administrative contact for the domain.
`tech` The technical contact for the domain.
`billing` The billing contact for the domain.
`reseller` The reseller contact for the domain.

DomainNameserverProvider

string


`custom` The nameservers do not match a recognized provider.
`alboweb` The nameservers are provided by Alboweb.
`domainchief` The nameservers use Domain Chief hosted DNS.
`sedo` The nameservers are provided by Sedo.
`versio` The nameservers are provided by Versio.
`vimexx` The nameservers are provided by Vimexx.
`cloudns` The nameservers are provided by ClouDNS.
`hetzner` The nameservers are provided by Hetzner.
`route53` The nameservers are provided by Amazon Route 53.
`transip` The nameservers are provided by TransIP.
`sectigo` The nameservers are provided by Sectigo.
`webmedia` The nameservers are provided by Webmedia - Nijmegen.
`spaceship` The nameservers are provided by Spaceship.
`nameshift` The nameservers are provided by Nameshift.
`cloudflare` The nameservers are provided by Cloudflare.
`dnsmanager` The nameservers are provided by dnsmanager.io.
`digitalocean` The nameservers are provided by DigitalOcean.
`openprovider` The nameservers are provided by Openprovider.

DomainNotice

code

DomainNoticeCode · required

Stable machine-readable condition. Use this as the primary branching key; each enum case documents when it can occur and which data may accompany it.


`domain.restore.available` The registry deleted the domain, but it remains within a time-limited restoration window.
`domain.payment.required` A registration or transfer is paused until payment is resolved through the API consumer's billing flow.
`domain.registration.failed` A new registration failed. Inspect `data.cause` and `actions`; support is offered when automated recovery is unavailable.
`domain.transfer.incoming.failed` An incoming transfer failed. The available actions indicate whether it can be retried, cancelled, or requires support.
`domain.contact_verification.required` Registrant contact verification is blocking or restricting the operation described by `data.operation`.
`domain.transfer.incoming.registrar_tag_required` An incoming push transfer is waiting for the current registrar's tag to be changed to `data.registrar_tag`.
`domain.registration.processing` A new registration request has been submitted and is still processing.
`domain.transfer.incoming.processing` An incoming transfer from another registrar is still processing.
`domain.transfer.internal.processing` A transfer between providers is still processing.
`domain.transfer.outgoing.approval_required` Another registrar requested an outgoing transfer and the authenticated caller may accept or reject it.
`domain.transfer.outgoing.approved` The outgoing transfer was accepted and is waiting for the registries to finish processing it.
`domain.transfer.incoming.scheduled` An incoming transfer is scheduled for `data.scheduled_transfer_at` and may still be changed before its lock time.
`domain.operation.processing` One or more requested changes are still being applied. No action is normally needed while they finish.
`domain.operation.failed` One or more requested changes could not be completed or need attention. The notice message and available actions explain what to do next.

type

DomainNoticeType · required

Whether intervention is required or the notice only communicates operational state.


`action_required` The domain cannot progress normally without customer, API-consumer, or support intervention. Available actions may be empty when domain state or policy leaves the actor without a supported resolution.
`notice` No intervention is currently required; show the notice when operational progress is useful to the customer.

severity

DomainNoticeSeverity · required

Presentation urgency. This is independent of the domain's lifecycle status.


`info` Normal operational information.
`warning` Attention is required or a deadline may apply.
`error` The attempted registration or transfer failed.

message

string · required

Human-readable fallback copy suitable for display. It may change or be localized; never use it for branching or persist it as state.

actions

DomainNoticeAction[] · required

Symbolic resolutions available for the domain and authenticated actor. The enum case documentation explains the user flow or API endpoint for each action. Values are omitted when domain state or policy prevents the actor from performing them. API token scopes do not filter this list; endpoint calls still require the scopes shown in their OpenAPI security requirements.

DomainNoticeData · required

Optional code-specific values needed to explain or carry out a resolution. Fields not relevant to this notice code are omitted; clients should ignore fields they do not recognize.

DomainNoticeAction

string

A resolution available for the domain and authenticated actor. Actions reflect domain state and policy authorization. API token scopes do not filter this list; each endpoint independently enforces the scopes documented in its OpenAPI security requirements.


`domain.support.contact` Direct the customer to the API consumer's support flow because no self-service completion path is available.
`domain.payment.resolve` Resolve payment in the API consumer's own billing flow. No Domain Chief API endpoint is provided for this action.
`domain.transfer.retry` Ask for a corrected authorization code and call `POST /domains/{domainNameOrId}/transfer/retry`.
`domain.registration.retry` Retry a failed registration with `POST /domains/{domainNameOrId}/registration/retry`.
`domain.transfer.cancel` Cancel the failed incoming transfer with `DELETE /domains/{domainNameOrId}/transfer`.
`domain.transfer.unlock_at_registrar` Tell the customer to disable the transfer lock at their current registrar before retrying.
`domain.nameservers.update` Let the customer correct the domain's authoritative nameservers through the domain update flow.
`domain.dnssec.update` Let the customer correct the domain's DNSSEC keys through the domain update flow.
`domain.auto_renewal.update` Let the customer correct the domain's auto-renewal setting through the domain update flow.
`domain.transfer_lock.update` Let the customer correct the domain's transfer lock through the domain update flow.
`domain.contacts.update` Let the customer correct the domain's registrant contacts through the domain update flow.
`domain.contact_verification.resend` Request another registrant contact verification with `POST /domains/{domainNameOrId}/contact-verification/resend`.
`domain.contact_verification.open` Open `data.contact_verification_url` in the customer's browser to complete contact verification.
`domain.transfer.registrar_tag.update` Ask the customer to set the registrar tag at their current registrar to `data.registrar_tag`.
`domain.transfer.outgoing.accept` Accept the outgoing transfer with `POST /domains/{domainNameOrId}/transfer/decision` and `decision` set to `accept`.
`domain.transfer.outgoing.reject` Reject the outgoing transfer with `POST /domains/{domainNameOrId}/transfer/decision` and `decision` set to `reject`.
`domain.transfer.schedule.update` Change the scheduled incoming transfer with `PATCH /domains/{domainNameOrId}/transfer/schedule`.
`domain.transfer.schedule.cancel` Cancel the scheduled incoming transfer with `DELETE /domains/{domainNameOrId}/transfer/schedule`.
`domain.operation.failure.dismiss` Hide a resolved failed-update notice with `POST /domains/{domainNameOrId}/operations/{operationId}/dismiss`. The failed attempt remains in domain activity.

DomainNoticeCode

string

Identifies the domain condition represented by a current notice. Branch on this value instead of the human-readable message. More values may be added, so clients should ignore unknown codes they cannot render specially.


`domain.restore.available` The registry deleted the domain, but it remains within a time-limited restoration window.
`domain.payment.required` A registration or transfer is paused until payment is resolved through the API consumer's billing flow.
`domain.registration.failed` A new registration failed. Inspect `data.cause` and `actions`; support is offered when automated recovery is unavailable.
`domain.transfer.incoming.failed` An incoming transfer failed. The available actions indicate whether it can be retried, cancelled, or requires support.
`domain.contact_verification.required` Registrant contact verification is blocking or restricting the operation described by `data.operation`.
`domain.transfer.incoming.registrar_tag_required` An incoming push transfer is waiting for the current registrar's tag to be changed to `data.registrar_tag`.
`domain.registration.processing` A new registration request has been submitted and is still processing.
`domain.transfer.incoming.processing` An incoming transfer from another registrar is still processing.
`domain.transfer.internal.processing` A transfer between providers is still processing.
`domain.transfer.outgoing.approval_required` Another registrar requested an outgoing transfer and the authenticated caller may accept or reject it.
`domain.transfer.outgoing.approved` The outgoing transfer was accepted and is waiting for the registries to finish processing it.
`domain.transfer.incoming.scheduled` An incoming transfer is scheduled for `data.scheduled_transfer_at` and may still be changed before its lock time.
`domain.operation.processing` One or more requested changes are still being applied. No action is normally needed while they finish.
`domain.operation.failed` One or more requested changes could not be completed or need attention. The notice message and available actions explain what to do next.

DomainNoticeData

attributes

DomainOperationAttribute[]

Domain attributes represented by a combined operation notice.

contact_verification_url

string | null · uri

Absolute HTTP or HTTPS URL where the registrant can complete contact verification. Present it only with the domain.contact_verification.open action and open it in the customer's browser. The URL may contain a time-limited verification token, so do not log, cache, fetch, or modify it.

registrar_tag

string | null

Tag the customer must configure at their current registrar to complete a push transfer.

restorable_until

string | null · date-time

Last known time at which support may still request registry restoration.

scheduled_transfer_at

string | null · date-time

Planned execution time for a scheduled incoming transfer.

scheduled_transfer_locks_at

string | null · date-time

Time after which the scheduled transfer can no longer be changed or cancelled.

auto_completes_at

string | null · date-time

Expected time at which an undecided outgoing transfer will be accepted automatically.

requires_intended_use

boolean | null

Whether retrying the incoming transfer also requires an intended-use declaration.

operation_id

string | null

\ChiefTools\DomainChief\Domain\Domain\Notice\Operation identifier required by operation-specific notice actions.

DomainNoticeOperation

string

Domain operation affected by a notice.


`registration` A new domain registration.
`transfer` An incoming domain transfer.
`contact_update` An update to the domain's registrant contact.

DomainNoticeSeverity

string

Presentation urgency for a notice; this is not a domain lifecycle status.


`info` Normal operational information.
`warning` Attention is required or a deadline may apply.
`error` The attempted registration or transfer failed.

DomainNoticeType

string

Whether a notice calls for intervention or only communicates state.


`action_required` The domain cannot progress normally without customer, API-consumer, or support intervention. Available actions may be empty when domain state or policy leaves the actor without a supported resolution.
`notice` No intervention is currently required; show the notice when operational progress is useful to the customer.

DomainOperationAttribute

string


`hosted_dns` Enable or disable Domain Chief hosted DNS.
`nameservers` Change the domain's authoritative nameservers.
`dnssec` Enable, disable, or update DNSSEC.
`auto_renewal` Enable or disable automatic domain renewal.
`transfer_lock` Enable or disable the registrar transfer lock.
`contacts` Change one or more domain contacts.
`whois_privacy` Enable or disable WHOIS privacy.
`auth_code` Request or refresh the domain transfer authorization code.

DomainStatus

string


`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.
`pending_payment` The domain registration or transfer is waiting for payment before it is processed.
`scheduled` The domain transfer has been scheduled but has not been requested at the registry yet.
`restorable` The domain has been deleted at the registry but is still restorable by the user.

DomainTransferDecision

string · enum

Enum values:

reject

Decision for a pending outgoing transfer.


`accept` Allow the domain to leave the current registrar account.
`reject` Refuse the outgoing transfer request.

DomainTransferType

string


`extend` The expiration date is extended with the time you have paid for at the outgoing registrar + a renewal period (usually 1 year). This is the most comoon.
`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.

DomainType

string


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

DomainWithNotices

id

string · required

name

string · required

The name of the domain without the top level domain.

Example: example

required

The top level domain of the domain name, can be expanded.

Example: com

domain

string · required

The full domain name.

Example: example.nl

type

DomainType · required

Indicates if the domain is a new registration or a transfer.


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

status

DomainStatus · required

The status of the domain. Most domain actions will be unavailable when the domain is not active.


`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.
`pending_payment` The domain registration or transfer is waiting for payment before it is processed.
`scheduled` The domain transfer has been scheduled but has not been requested at the registry yet.
`restorable` The domain has been deleted at the registry but is still restorable by the user.

is_premium

boolean · required

Indicates if the domain is a premium domain which might have a higher price then normal for renewals.

is_locked

boolean | 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_enabled

boolean · required

Indicates if the domain is automatically renewed, if not enabled the domain will expire unless manually renewed.

is_whois_privacy_enabled

boolean | 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_dns

boolean · 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_enabled

boolean | null · required

Indicates if the domain has DNSSEC enabled, when DNSSEC is not supported by the TLD this value will be null.

object · 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"}

DNSSECKey[] · required

The list of DNSSEC keys configured for the domain. This list will always be empty when DNSSEC is not supported.

object[] · required

The list of nameservers configured for the domain name.

nameserver_provider

DomainNameserverProvider · required

The detected nameserver provider for the domain, this is based on the nameservers configured.


`custom` The nameservers do not match a recognized provider.
`alboweb` The nameservers are provided by Alboweb.
`domainchief` The nameservers use Domain Chief hosted DNS.
`sedo` The nameservers are provided by Sedo.
`versio` The nameservers are provided by Versio.
`vimexx` The nameservers are provided by Vimexx.
`cloudns` The nameservers are provided by ClouDNS.
`hetzner` The nameservers are provided by Hetzner.
`route53` The nameservers are provided by Amazon Route 53.
`transip` The nameservers are provided by TransIP.
`sectigo` The nameservers are provided by Sectigo.
`webmedia` The nameservers are provided by Webmedia - Nijmegen.
`spaceship` The nameservers are provided by Spaceship.
`nameshift` The nameservers are provided by Nameshift.
`cloudflare` The nameservers are provided by Cloudflare.
`dnsmanager` The nameservers are provided by dnsmanager.io.
`digitalocean` The nameservers are provided by DigitalOcean.
`openprovider` The nameservers are provided by Openprovider.

intended_use

string | null · required

The customer-supplied description of how the domain will be used when required by the registry.

renews_at

string | 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_at

string | 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_price

integer · required

Example: 826

mail_forward_status

MailForwardingStatus · required

The current mail-forwarding lifecycle status for the domain.


`disabled` The mail forward feature is disabled / not setup.
`pending` The mail forward feature is provisioned and waiting for verification.
`active` The mail forward feature is enabled and active (DNS configured correctly).
`failed` We could not verify the mail forward feature (DNS records possibly not configured correctly).

mail_forward_renews_at

string | null · date-time · required

The date on which mail forwarding will renew. This remains set when forwarding is disabled during a paid period.

scheduled_transfer_at

string | null · date-time · required

The date and time at which a scheduled incoming transfer will be requested.

scheduled_transfer_locks_at

string | null · date-time · required

The date and time after which the transfer schedule can no longer be moved or cancelled.

DomainNotice[] · required

Current actionable conditions and operational updates for this domain. A domain can have multiple notices at once, for example contact verification together with a scheduled transfer. Treat code, type, severity, actions, and data as the integration contract; message is display copy. New notice codes, actions, and data fields may be added, so clients should ignore values they do not yet support.

object · required

Metadata attached to the domain.

MailForward

id

string · required

alias

string · required

The local part to forward. Use * to match every otherwise unmatched address.

target

string · required

The email address that receives forwarded messages.

MailForwardRequest

alias

string · maxLength: 255 · required

The local part to forward. Use * as a catch-all alias.

target

string · email · maxLength: 255 · required

The email address that receives forwarded messages.

MailForwarding

domain

string · required

The domain name configured for mail forwarding.

status

MailForwardingStatus · required

The current provisioning and verification status.


`disabled` The mail forward feature is disabled / not setup.
`pending` The mail forward feature is provisioned and waiting for verification.
`active` The mail forward feature is enabled and active (DNS configured correctly).
`failed` We could not verify the mail forward feature (DNS records possibly not configured correctly).

renews_at

string | null · date-time · required

The date on which the paid mail-forwarding period renews.

MailForwardingStatus

string


`disabled` The mail forward feature is disabled / not setup.
`pending` The mail forward feature is provisioned and waiting for verification.
`active` The mail forward feature is enabled and active (DNS configured correctly).
`failed` We could not verify the mail forward feature (DNS records possibly not configured correctly).

TLD

name

string · required

The name of the TLD.

Example: eu

handle_types

DomainHandleType[] · required

Supported domain handle types for this TLD.

Example: ["owner","admin","tech","billing"]

transfer_type

DomainTransferType · required

This indicates how the transfer is handled by the registry.


`extend` The expiration date is extended with the time you have paid for at the outgoing registrar + a renewal period (usually 1 year). This is the most comoon.
`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.

registration_price

integer · 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_price

integer · 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_price

integer · 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

is_converted_currency

boolean · required

Indicates if the TLD's prices are converted to EUR. When true, the prices returned are converted to EUR using the current exchange rate which means they might fluctuate based on the current exchange rate.

supports_dnssec

boolean · required

Indicates if the TLD supports DNSSEC.

supports_idn

boolean · required

Indicates whether this provider supports internationalized domain names for the TLD.

minimum_label_length

integer | null · required

Minimum length of the canonical ASCII label, including the xn-- prefix for IDNs.

maximum_label_length

integer | null · required

Maximum length of the canonical ASCII label, including the xn-- prefix for IDNs.

supported_dnssec_algorithms

DNSSECKeyAlgorithm[] · required

The list of DNSSEC algorithms supported by the TLD.

Example: [13]

supports_whois_privacy

boolean · required

Indicates if the TLD supports WHOIS privacy.

is_trade_required

boolean · required

Indicates if the TLD requires a trade operation for owner changes.

is_auth_code_available

boolean · required

Indicates if an auth-code can be retrieved for this TLD. When this is true you can use the GET endpoint to retrieve the auth-code for a domain directly. When this is false you need to use the POST endpoint to request the auth-code to be sent to the domain owner.

requires_intended_use

boolean · required

Indicates if registrations and transfers require a description of the intended domain use.

TeamEvent

id

string · required

Stable identifier for this event.

type

TeamEventType · required

The event type. New values may be introduced over time.


`domain.changed` The domain's current state changed and should be retrieved again.
`contact.created` A contact was created.
`contact.changed` A contact's current state changed and should be retrieved again.
`contact.deleted` A contact was deleted.
`dns_record.created` A DNS record was created.
`dns_record.changed` A DNS record's current state changed and should be retrieved again.
`dns_record.deleted` A DNS record was deleted.
`web_redirect.created` A web redirect was created.
`web_redirect.changed` A web redirect's current state changed and should be retrieved again.
`web_redirect.deleted` A web redirect was deleted.
`mail_forward.created` A mail forward was created.
`mail_forward.changed` A mail forward's current state changed and should be retrieved again.
`mail_forward.deleted` A mail forward was deleted.
`domain.registration.requested` Domain registration was requested. This event is billable.
`domain.registration.request_cancelled` Domain registration request was cancelled before it was sent to the registrar.
`domain.registration.succeeded` Domain registration succeeded. Domain is now registered at the registry and manageable within Domain Chief.
`domain.registration.failed` Domain registration failed. Domain is not registered at the registry and can possibly be retried.
`domain.registration.retry_requested` Domain registration retry was requested.
`domain.transfer.incoming.requested` Domain transfer was requested. This event is billable.
`domain.transfer.incoming.request_cancelled` Domain transfer request was cancelled before it was sent to the registrar.
`domain.transfer.incoming.succeeded` Domain transfer succeeded. Domain is now transferred at the registry and manageable within Domain Chief.
`domain.transfer.incoming.failed` Domain transfer failed. Domain is not transferred at the registry and can possibly be retried.
`domain.transfer.incoming.retry_requested` Domain transfer retry was requested.
`domain.transfer.incoming.scheduled` Domain transfer was scheduled for a future moment.
`domain.transfer.incoming.schedule_moved` Domain transfer schedule was moved to a new future moment.
`domain.transfer.incoming.schedule_cancelled` Domain transfer schedule was cancelled.
`domain.transfer.outgoing.requested` Domain transfer out was requested by another registrar and can be accepted or rejected by the owner.
`domain.transfer.outgoing.succeeded` Domain transfer out succeeded. Domain is now transferred out at the registry and no longer manageable within Domain Chief.
`domain.transfer.outgoing.accepted` Domain transfer out was accepted.
`domain.transfer.outgoing.rejected` Domain transfer out was rejected.
`domain.transfer.outgoing.cancelled` Domain transfer out was cancelled.
`domain.transfer.push.requested` Domain push transfer (tag change) was requested to transfer the domain to another registrar.
`domain.transfer.push.failed` Domain push transfer (tag change) failed at the registry.
`domain.transfer.push.rejected` Domain push transfer (tag change) was rejected by the receiving registrar.
`domain.renewal.succeeded` Domain renewal succeeded. Domain expiry date has been extended at the registry. This event is billable.
`domain.payment.received` Payment for a pending domain operation was received.
`domain.delete.requested` Domain deletion was requested and will be sent to the registry asynchronously.
`domain.delete.failed` Domain deletion failed at the registry. Domain is still active.
`domain.deleted` Domain was deleted at the registry and is no longer manageable within Domain Chief.
`domain.expired` Domain was marked as expired, domain is still restorable until deletion at the registry.
`domain.restore.requested` Domain restoration was requested and will be sent to the registry asynchronously.
`domain.restore.succeeded` Domain was restored at the registry and is manageable within Domain Chief again. This event is billable.
`domain.restore.failed` Domain restoration failed at the registry. Domain is still restorable if the restore period has not ended.
`domain.update.nameservers` Domain nameservers were updated (can include old and new values).
`domain.update.nameservers_failed` A requested nameserver update was rejected by the registry and the confirmed nameservers were restored.
`domain.update.lock_enabled` Domain transfer lock was enabled.
`domain.update.lock_disabled` Domain transfer lock was disabled.
`domain.update.lock_failed` A requested domain transfer lock update was rejected and the confirmed setting was restored.
`domain.update.whois_privacy_enabled` Domain WHOIS privacy was enabled.
`domain.update.whois_privacy_disabled` Domain WHOIS privacy was disabled.
`domain.update.whois_privacy_failed` A requested WHOIS privacy update was rejected and the confirmed setting was restored.
`domain.update.auto_renew_enabled` Domain auto-renewal was enabled.
`domain.update.auto_renew_disabled` Domain auto-renewal was disabled.
`domain.update.auto_renew_failed` A requested auto-renewal update was rejected and the confirmed setting was restored.
`domain.update.contacts` Domain contacts were updated (can include old and new values).
`domain.update.contacts_failed` A requested contact update was rejected and the confirmed contacts were restored.
`domain.update.contacts_and_whois_privacy_failed` A combined contact and WHOIS privacy update was rejected and the confirmed state was restored.
`domain.update.dnssec_keys` Domain DNSSEC keys were updated (can include old and new values).
`domain.update.dnssec_enabled` Domain DNSSEC was enabled.
`domain.update.dnssec_disabled` Domain DNSSEC was disabled.
`domain.update.dnssec_failed` A requested DNSSEC update was rejected by the registry and the confirmed DNSSEC state was restored.
`domain.update.hosted_dns_enabled` Domain hosted DNS was enabled.
`domain.update.hosted_dns_disabled` Domain hosted DNS was disabled.
`domain.update.hosted_dns_sync_failed` One or more hosted DNS records failed to sync upstream.
`domain.update.hosted_dns_restored` Hosted DNS records were restored from a zone snapshot in DNS History.
`domain.dns.scheduled_change.created` A hosted DNS change was scheduled.
`domain.dns.scheduled_change.revised` A pending scheduled hosted DNS change was revised.
`domain.dns.scheduled_change.cancelled` A pending scheduled hosted DNS change was cancelled.
`domain.dns.scheduled_change.applied` A scheduled hosted DNS change was accepted by the provider.
`domain.dns.scheduled_change.conflicted` A scheduled hosted DNS change was stopped because affected records drifted.
`domain.dns.scheduled_change.superseded` A locally applied scheduled hosted DNS change was replaced before publication completed.
`domain.dns.scheduled_change.publish_failed` A locally applied scheduled hosted DNS change could not be published.
`domain.mail_forward.renewed` Domain mail forwarding was renewed for another billing period. This event is billable.
`domain.mail_forward.enabled` Domain mail forwarding was enabled. This event is billable.
`domain.mail_forward.disabled` Domain mail forwarding was disabled.
`domain.transfer.internal` Domain was transferred between providers within Domain Chief, this event is purely informational.
`domain.contact_verification.required` Domain contact verification was requested for the registrant contact, this is required by some registries after domain registration or transfer.
`domain.contact_verification.approved` Domain contact verification was approved for the registrant contact.
`domain.imported` Domain was created outside Domain Chief and imported to be managed, no prior history is available.

Example: domain.changed

object · required

The resource this event relates to. Nested resources include the domain that owns them so you can select the matching domain-scoped endpoint.

required

Related activity ID, or the full activity when requested through expand[]=activity. This is null when the event has no related activity.

occurred_at

string · date-time · required

Time at which the event occurred.

TeamEventResourceType

string


`domain` A domain managed by the team.
`contact` A contact belonging to the team.
`dns_record` A DNS record belonging to a domain managed by the team.
`web_redirect` A web redirect belonging to a domain managed by the team.
`mail_forward` A mail forward belonging to a domain managed by the team.

TeamEventType

string


`domain.changed` The domain's current state changed and should be retrieved again.
`contact.created` A contact was created.
`contact.changed` A contact's current state changed and should be retrieved again.
`contact.deleted` A contact was deleted.
`dns_record.created` A DNS record was created.
`dns_record.changed` A DNS record's current state changed and should be retrieved again.
`dns_record.deleted` A DNS record was deleted.
`web_redirect.created` A web redirect was created.
`web_redirect.changed` A web redirect's current state changed and should be retrieved again.
`web_redirect.deleted` A web redirect was deleted.
`mail_forward.created` A mail forward was created.
`mail_forward.changed` A mail forward's current state changed and should be retrieved again.
`mail_forward.deleted` A mail forward was deleted.
`domain.registration.requested` Domain registration was requested. This event is billable.
`domain.registration.request_cancelled` Domain registration request was cancelled before it was sent to the registrar.
`domain.registration.succeeded` Domain registration succeeded. Domain is now registered at the registry and manageable within Domain Chief.
`domain.registration.failed` Domain registration failed. Domain is not registered at the registry and can possibly be retried.
`domain.registration.retry_requested` Domain registration retry was requested.
`domain.transfer.incoming.requested` Domain transfer was requested. This event is billable.
`domain.transfer.incoming.request_cancelled` Domain transfer request was cancelled before it was sent to the registrar.
`domain.transfer.incoming.succeeded` Domain transfer succeeded. Domain is now transferred at the registry and manageable within Domain Chief.
`domain.transfer.incoming.failed` Domain transfer failed. Domain is not transferred at the registry and can possibly be retried.
`domain.transfer.incoming.retry_requested` Domain transfer retry was requested.
`domain.transfer.incoming.scheduled` Domain transfer was scheduled for a future moment.
`domain.transfer.incoming.schedule_moved` Domain transfer schedule was moved to a new future moment.
`domain.transfer.incoming.schedule_cancelled` Domain transfer schedule was cancelled.
`domain.transfer.outgoing.requested` Domain transfer out was requested by another registrar and can be accepted or rejected by the owner.
`domain.transfer.outgoing.succeeded` Domain transfer out succeeded. Domain is now transferred out at the registry and no longer manageable within Domain Chief.
`domain.transfer.outgoing.accepted` Domain transfer out was accepted.
`domain.transfer.outgoing.rejected` Domain transfer out was rejected.
`domain.transfer.outgoing.cancelled` Domain transfer out was cancelled.
`domain.transfer.push.requested` Domain push transfer (tag change) was requested to transfer the domain to another registrar.
`domain.transfer.push.failed` Domain push transfer (tag change) failed at the registry.
`domain.transfer.push.rejected` Domain push transfer (tag change) was rejected by the receiving registrar.
`domain.renewal.succeeded` Domain renewal succeeded. Domain expiry date has been extended at the registry. This event is billable.
`domain.payment.received` Payment for a pending domain operation was received.
`domain.delete.requested` Domain deletion was requested and will be sent to the registry asynchronously.
`domain.delete.failed` Domain deletion failed at the registry. Domain is still active.
`domain.deleted` Domain was deleted at the registry and is no longer manageable within Domain Chief.
`domain.expired` Domain was marked as expired, domain is still restorable until deletion at the registry.
`domain.restore.requested` Domain restoration was requested and will be sent to the registry asynchronously.
`domain.restore.succeeded` Domain was restored at the registry and is manageable within Domain Chief again. This event is billable.
`domain.restore.failed` Domain restoration failed at the registry. Domain is still restorable if the restore period has not ended.
`domain.update.nameservers` Domain nameservers were updated (can include old and new values).
`domain.update.nameservers_failed` A requested nameserver update was rejected by the registry and the confirmed nameservers were restored.
`domain.update.lock_enabled` Domain transfer lock was enabled.
`domain.update.lock_disabled` Domain transfer lock was disabled.
`domain.update.lock_failed` A requested domain transfer lock update was rejected and the confirmed setting was restored.
`domain.update.whois_privacy_enabled` Domain WHOIS privacy was enabled.
`domain.update.whois_privacy_disabled` Domain WHOIS privacy was disabled.
`domain.update.whois_privacy_failed` A requested WHOIS privacy update was rejected and the confirmed setting was restored.
`domain.update.auto_renew_enabled` Domain auto-renewal was enabled.
`domain.update.auto_renew_disabled` Domain auto-renewal was disabled.
`domain.update.auto_renew_failed` A requested auto-renewal update was rejected and the confirmed setting was restored.
`domain.update.contacts` Domain contacts were updated (can include old and new values).
`domain.update.contacts_failed` A requested contact update was rejected and the confirmed contacts were restored.
`domain.update.contacts_and_whois_privacy_failed` A combined contact and WHOIS privacy update was rejected and the confirmed state was restored.
`domain.update.dnssec_keys` Domain DNSSEC keys were updated (can include old and new values).
`domain.update.dnssec_enabled` Domain DNSSEC was enabled.
`domain.update.dnssec_disabled` Domain DNSSEC was disabled.
`domain.update.dnssec_failed` A requested DNSSEC update was rejected by the registry and the confirmed DNSSEC state was restored.
`domain.update.hosted_dns_enabled` Domain hosted DNS was enabled.
`domain.update.hosted_dns_disabled` Domain hosted DNS was disabled.
`domain.update.hosted_dns_sync_failed` One or more hosted DNS records failed to sync upstream.
`domain.update.hosted_dns_restored` Hosted DNS records were restored from a zone snapshot in DNS History.
`domain.dns.scheduled_change.created` A hosted DNS change was scheduled.
`domain.dns.scheduled_change.revised` A pending scheduled hosted DNS change was revised.
`domain.dns.scheduled_change.cancelled` A pending scheduled hosted DNS change was cancelled.
`domain.dns.scheduled_change.applied` A scheduled hosted DNS change was accepted by the provider.
`domain.dns.scheduled_change.conflicted` A scheduled hosted DNS change was stopped because affected records drifted.
`domain.dns.scheduled_change.superseded` A locally applied scheduled hosted DNS change was replaced before publication completed.
`domain.dns.scheduled_change.publish_failed` A locally applied scheduled hosted DNS change could not be published.
`domain.mail_forward.renewed` Domain mail forwarding was renewed for another billing period. This event is billable.
`domain.mail_forward.enabled` Domain mail forwarding was enabled. This event is billable.
`domain.mail_forward.disabled` Domain mail forwarding was disabled.
`domain.transfer.internal` Domain was transferred between providers within Domain Chief, this event is purely informational.
`domain.contact_verification.required` Domain contact verification was requested for the registrant contact, this is required by some registries after domain registration or transfer.
`domain.contact_verification.approved` Domain contact verification was approved for the registrant contact.
`domain.imported` Domain was created outside Domain Chief and imported to be managed, no prior history is available.

WebRedirect

id

string · required

subdomain

string | null · required

The subdomain being redirected. When the subdomain is null the www subdomain is implied.

status_code

integer · required

The status code used for the redirect.

Example: 301

target

string · required

The target URL of the redirect.

Example: https://example.nl

include_path

boolean · required

Indicates if the path should be appended to the target URL.

include_query

boolean · required

Indicates if the query string should be appended to the target URL.