Schemas
ACMEChallenge
idThe ID of the TXT record holding the challenge value.
domainThe domain the challenge record was published on.
nameThe fully qualified challenge name.
valueThe published challenge value.
ttlThe record TTL in seconds.
created_atThe ISO-8601 timestamp when the challenge value was published.
Contact
handleThe parent contact of this contact. When expanded, contains the full contact object.
entity_typecompany_namefirst_namelast_namecompany_registration_numbercompany_trading_namecompany_urlvat_registrationaddress_streetaddress_house_numberaddress_postal_codeaddress_cityaddress_stateState, province or region code. Only present for countries that have states/provinces/regions (e.g. US, CA, GB).
address_state_nameFull state or province name. Only present when address_state is set.
address_country_codeCountry code in ISO 3166-1 alpha-2 format.
emailphonePhone numbers are in international format.
TLD-specific extension data.
is_defaultIndicates if the contact is the default contact for the team.
Metadata attached to the contact.
ContactApplicantPurpose
P1 Business use for profit |
P2 Non-profit business, club, association, religious organization, etc. |
P3 Personal use |
P4 Educational purposes |
P5 Government purposes |
ContactIeContactType
The registrant's relation with Ireland, required by the .ie registry.
CHA A charitable organization based in Ireland, requires a supporting (charity) number |
COM A business or company incorporated in Ireland, requires a company registration number |
OTH An individual or organization with another connection to Ireland |
ContactNexusCategory
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
idtypeThe 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. |
nameThe record name. When empty the record is for the root domain. This never includes the domain name itself.
contentThe record content.
ttlThe record TTL in seconds.
prioThe record priority. Only available for certain record types, will always be 0 when not supported and ignored when creating/updating.
commentAn optional comment for the record.
sync_errorThe latest hosted DNS sync error for this record, if any.
sync_error_atThe ISO-8601 timestamp when the latest hosted DNS sync error was recorded.
Metadata attached to the record.
DNSRecordImportBlockerCode
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
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_domainThe zone name used to interpret relative record names in the imported data.
destination_domainThe hosted DNS domain targeted by the import.
modeThe 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. |
fingerprintAn opaque identifier for this imported data and the current destination zone.
DNS records the import would add.
DNS records the import would remove.
Existing DNS records the import would leave unchanged.
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. Messages are translated with Accept-Language.
DNSRecordType
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_keyPublic key for the DNSSEC key.
algorithmAlgorithm 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 |
flagsFlags for the DNSSEC key. 257 for KSK and 256 for ZSK.
256 ZSK |
257 KSK |
protocolThis will always be 3 (DNSSEC).
DNSSECKeyAlgorithm
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 |
DNSZoneSnapshot
idkindWhether Domain Chief or a user saved the snapshot.
automatic Saved automatically before a DNS change. |
manual Saved manually and retained until it is deleted. |
nameThe user-supplied name of a manual snapshot.
display_nameA ready-to-display name for the snapshot: the user-supplied name, or a description of when it was captured. The description is translated with Accept-Language.
The entity that saved the snapshot.
record_countThe number of DNS records stored in the snapshot.
created_atThe ISO-8601 timestamp when the snapshot was saved.
Every DNS record stored in the snapshot.
DNSZoneSnapshotKind
automatic Saved automatically before a DNS change. |
manual Saved manually and retained until it is deleted. |
DNSZoneSnapshotReason
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 The first snapshot of the zone, the starting point of its history. |
scheduled_change Captured before a scheduled DNS change was applied. |
DNSZoneSnapshotRecord
typeA 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. |
nameThe record name without the domain name. An empty value represents the zone root.
contentThe record content in the same form used by the DNS record API.
ttlThe record TTL in seconds.
prioThe record priority.
commentThe optional record comment.
DNSZoneSnapshotRecordChange
The current DNS record.
The DNS record stored in the snapshot.
DNSZoneSnapshotRestorePlan
snapshot_idThe snapshot that would be restored.
fingerprintAn opaque identifier for this snapshot and the current hosted DNS zone.
DNS records the restore would add.
DNS records the restore would remove.
Existing DNS records the restore would change.
Existing DNS records that already match the snapshot.
DNSZoneSnapshotSummary
idkindWhether Domain Chief or a user saved the snapshot.
automatic Saved automatically before a DNS change. |
manual Saved manually and retained until it is deleted. |
nameThe user-supplied name of a manual snapshot.
display_nameA ready-to-display name for the snapshot: the user-supplied name, or a description of when it was captured. The description is translated with Accept-Language.
The entity that saved the snapshot.
record_countThe number of DNS records stored in the snapshot.
created_atThe ISO-8601 timestamp when the snapshot was saved.
Domain
idnameThe name of the domain without the top level domain.
The top level domain of the domain name, can be expanded.
domainThe full domain name.
unicode_domainThe full domain name as Unicode, this differs from domain only for internationalized domain names.
typeIndicates 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. |
statusThe 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_premiumIndicates if the domain is a premium domain which might have a higher price then normal for renewals.
is_lockedIndicates 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_enabledIndicates if the domain is automatically renewed, if not enabled the domain will expire unless manually renewed.
is_whois_privacy_enabledIndicates if the domain has WHOIS privacy enabled, when WHOIS privacy is not supported by the TLD this value will be null.
is_using_hosted_dnsIndicates if the domain us using hosted DNS from Domain Chief instead of custom nameservers, this means DNS records can be managed.
is_dnssec_enabledIndicates if the domain has DNSSEC enabled, when DNSSEC is not supported by the TLD this value will be null.
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.
The list of DNSSEC keys configured for the domain. This list will always be empty when DNSSEC is not supported.
The list of nameservers configured for the domain name.
nameserver_providerThe 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_useThe customer-supplied description of how the domain will be used when required by the registry.
renews_atThe date on which the domain will renew. Can be null if auto-renewal is disabled or the domain is not yet registered.
expires_atThe 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_priceThe 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.
mail_forward_statusThe 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_atThe date on which mail forwarding will renew. This remains set when forwarding is disabled during a paid period.
scheduled_transfer_atThe date and time at which a scheduled incoming transfer will be requested.
scheduled_transfer_locks_atThe date and time after which the transfer schedule can no longer be moved or cancelled.
Restrictions currently imposed by the registry, such as a (scheduled) suspension. A restricted domain keeps its status, so check this list to find out whether an active domain is suspended. The list is empty when the domain is not restricted.
Metadata attached to the domain.
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
ideventThe 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.requested A manual domain renewal was requested. This event is billable. |
domain.renewal.request_cancelled An unpaid manual renewal request was cancelled. |
domain.renewal.failed A manual renewal was rejected by the registrar. |
domain.renewal.succeeded Domain renewal succeeded. Domain expiry date has been extended at the registry. Automatic renewals are 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.restorable Domain was deleted at the registry and is restorable until the restore period ends, after which it is permanently deleted. |
domain.deleted Domain was permanently deleted at the registry and is no longer manageable within Domain Chief. Recorded once, when the domain is deleted without a restore period or when its restore period ends. |
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. This event is billable. |
domain.restore.request_cancelled Domain restoration request was cancelled before it was sent to the registrar. |
domain.restore.succeeded Domain was restored at the registry and is manageable within Domain Chief again. |
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.registry.suspension_scheduled The registry scheduled the domain for suspension, for example because the registrant must validate their identity or registration data. |
domain.registry.suspension_cancelled The registry cancelled the scheduled suspension of the domain. |
domain.registry.suspended The registry suspended the domain, a suspended domain does not resolve. |
domain.registry.reinstated The registry lifted the suspension of the domain. |
domain.registry.on_hold The registry placed the domain on hold. |
domain.registry.on_hold_removed The registry removed the hold from the domain. |
domain.registry.seized The registry seized the domain. |
domain.registry.seizure_removed The registry lifted the seizure of the domain. |
domain.imported Domain was created outside Domain Chief and imported to be managed, no prior history is available. |
descriptionA textual description of this activity.
The entity that caused this activity.
The subject this activity is related to.
Additional properties related to this activity. Domain registrations and transfers may include price and premium indicator for example.
created_atThe date and time this activity occured.
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).
cursorCursor for pagination. Pass this value to the cursor query parameter to paginate after this activity.
DomainActivityCauser
idThe 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.
typeThe 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. |
nameThe name of the causer. This can be the name of the user, team or token, or System for automated actions. System is translated with Accept-Language.
DomainActivityCauserType
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
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.requested A manual domain renewal was requested. This event is billable. |
domain.renewal.request_cancelled An unpaid manual renewal request was cancelled. |
domain.renewal.failed A manual renewal was rejected by the registrar. |
domain.renewal.succeeded Domain renewal succeeded. Domain expiry date has been extended at the registry. Automatic renewals are 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.restorable Domain was deleted at the registry and is restorable until the restore period ends, after which it is permanently deleted. |
domain.deleted Domain was permanently deleted at the registry and is no longer manageable within Domain Chief. Recorded once, when the domain is deleted without a restore period or when its restore period ends. |
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. This event is billable. |
domain.restore.request_cancelled Domain restoration request was cancelled before it was sent to the registrar. |
domain.restore.succeeded Domain was restored at the registry and is manageable within Domain Chief again. |
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.registry.suspension_scheduled The registry scheduled the domain for suspension, for example because the registrant must validate their identity or registration data. |
domain.registry.suspension_cancelled The registry cancelled the scheduled suspension of the domain. |
domain.registry.suspended The registry suspended the domain, a suspended domain does not resolve. |
domain.registry.reinstated The registry lifted the suspension of the domain. |
domain.registry.on_hold The registry placed the domain on hold. |
domain.registry.on_hold_removed The registry removed the hold from the domain. |
domain.registry.seized The registry seized the domain. |
domain.registry.seizure_removed The registry lifted the seizure of the domain. |
domain.imported Domain was created outside Domain Chief and imported to be managed, no prior history is available. |
DomainActivityProperties
priceBillable amount in EUR cents.
premiumWhether the billable operation involved premium registry pricing.
registry_messageSanitized display message returned by the registrar.
Persisted immutable cause for a failed domain operation. Omitted when no cause was captured, including for legacy activities.
operation_idDomain operation identifier associated with this activity.
rollbackWhether this event describes state restored after a rejected registry update.
Previous values for supported update events.
New values for supported update events.
DomainActivitySubject
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: id, type, name +1 more | |
| type = object · requires: id, type, name +1 more |
idThe unique identifier of the subject.
typedomain The activity subject is a domain. |
nameThe name of the subject.
permalinkDomainAvailability
free Domain is available for registration |
owned Domain is owned by the authenticated team |
active Domain is registered, may be transferable |
unavailable Domain is registered, reserved or blocked by the registry and can be neither registered nor transferred |
error An error has occured retrieving availability |
DomainAvailabilityResult
The top level domain of the domain name, can be expanded.
nameThe name of the domain without the top level domain.
domainThe full domain name.
is_premiumIndicates if the domain is a premium domain which might have a higher price then normal for registration and renewals.
availabilityThe 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 |
unavailable Domain is registered, reserved or blocked by the registry and can be neither registered nor transferred |
error An error has occured retrieving availability |
priceThe 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_priceThe 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_currencyIndicates 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_dateThe 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
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. |
upcoming_renewal Verification is requested ahead of the domain's upcoming renewal. The domain keeps working and renews as usual if verification is not completed in time. |
DomainFailureCause
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. |
recently_registered_or_transferred The domain was registered or transferred too recently to be transferred again. |
invalid_nameservers The registry rejected the submitted authoritative nameserver configuration. |
glue_records_missing A nameserver within the domain was submitted without the glue IPv4 or IPv6 address the registry requires. |
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
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
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
codeStable 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, transfer, or manual renewal is paused until payment is resolved. Renewal details are provided in data when operation is renewal. |
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. |
domain.registry.suspension_scheduled The registry will suspend the domain on data.suspension_scheduled_at unless the reason in data.registry_restriction_reason is resolved first. For registrant validation, the registry contacts the registrant directly and correcting the registrant contact can help. |
domain.registry.suspended The registry suspended the domain and it does not resolve. The reason is in data.registry_restriction_reason, with an optional registry explanation in data.registry_restriction_detail. |
domain.registry.on_hold The registry placed the domain on hold, it cannot be changed or transferred. The reason is in data.registry_restriction_reason, with an optional registry explanation in data.registry_restriction_detail. |
domain.registry.seized The registry seized the domain. The reason is in data.registry_restriction_reason, with an optional registry explanation in data.registry_restriction_detail. |
typeWhether 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. |
severityPresentation 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. |
messageHuman-readable fallback copy suitable for display. Translated with Accept-Language. It may change; never use it for branching or persist it as state.
actionsSymbolic 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.
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
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.restore Confirm data.restore_price and call POST /domains/{domainNameOrId}/restore with confirmed_price. |
domain.support.contact Direct the customer to the API consumer's support flow because no self-service completion path is available. |
domain.payment.resolve Direct the customer to the existing web checkout to resolve payment. No API checkout 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
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, transfer, or manual renewal is paused until payment is resolved. Renewal details are provided in data when operation is renewal. |
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. |
domain.registry.suspension_scheduled The registry will suspend the domain on data.suspension_scheduled_at unless the reason in data.registry_restriction_reason is resolved first. For registrant validation, the registry contacts the registrant directly and correcting the registrant contact can help. |
domain.registry.suspended The registry suspended the domain and it does not resolve. The reason is in data.registry_restriction_reason, with an optional registry explanation in data.registry_restriction_detail. |
domain.registry.on_hold The registry placed the domain on hold, it cannot be changed or transferred. The reason is in data.registry_restriction_reason, with an optional registry explanation in data.registry_restriction_detail. |
domain.registry.seized The registry seized the domain. The reason is in data.registry_restriction_reason, with an optional registry explanation in data.registry_restriction_detail. |
DomainNoticeData
attributesDomain attributes represented by a combined operation notice.
renewal_yearsWhole years requested for a prepaid manual renewal awaiting payment.
renewal_priceTotal price of a prepaid manual renewal, in EUR cents excluding VAT.
resulting_expires_atExpected expiration timestamp after a prepaid manual renewal.
contact_verification_urlAbsolute 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_tagTag the customer must configure at their current registrar to complete a push transfer.
restorable_untilLast known time at which support may still request registry restoration.
scheduled_transfer_atPlanned execution time for a scheduled incoming transfer.
scheduled_transfer_locks_atTime after which the scheduled transfer can no longer be changed or cancelled.
auto_completes_atExpected time at which an undecided outgoing transfer will be accepted automatically.
requires_intended_useWhether retrying the incoming transfer also requires an intended-use declaration.
registry_restriction_detailExplanation provided by the registry for the restriction, when available. Display it as-is to the customer.
restricted_sinceTime since which the registry restriction applies.
suspension_scheduled_atTime at which the registry will suspend the domain, when the registry provided it.
operation_id\ChiefTools\DomainChief\Domain\Domain\Notice\Operation identifier required by operation-specific notice actions.
DomainNoticeOperation
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. |
renewal A manual renewal of an active domain. |
DomainNoticeSeverity
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
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
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. |
renewal Extend the domain registration at the registry. |
DomainRegistryRestriction
typeThe kind of restriction the registry imposed on the domain.
suspension_scheduled The registry will suspend the domain on the scheduled date unless the reason is resolved before then. |
suspended The registry suspended the domain. A suspended domain does not resolve. |
on_hold The registry placed the domain on hold. A domain on hold cannot be changed or transferred. |
seized The registry seized the domain. |
reasonWhy the registry restricted the domain.
registrant_validation The registry requires the registrant to validate their identity or registration data. Correcting the registrant contact details can resolve this. |
legal The registry restricted the domain following a legal investigation or legal action. |
unknown The registry did not provide a reason. |
detailExplanation provided by the registry, when available. Display it as-is to the customer.
effective_atFor suspension_scheduled, the time at which the registry will suspend the domain when the registry provided it.
sinceThe time since which the restriction applies.
DomainRegistryRestrictionReason
Why the registry restricted the domain. More values may be added, so clients should treat unknown reasons as unknown.
registrant_validation The registry requires the registrant to validate their identity or registration data. Correcting the registrant contact details can resolve this. |
legal The registry restricted the domain following a legal investigation or legal action. |
unknown The registry did not provide a reason. |
DomainRegistryRestrictionType
A restriction imposed on the domain by its registry. The domain stays registered while restricted, but it may not resolve or accept changes. More values may be added, so clients should treat unknown restrictions as limiting the domain.
suspension_scheduled The registry will suspend the domain on the scheduled date unless the reason is resolved before then. |
suspended The registry suspended the domain. A suspended domain does not resolve. |
on_hold The registry placed the domain on hold. A domain on hold cannot be changed or transferred. |
seized The registry seized the domain. |
DomainRenewalQuote
domain_idThe domain's ID.
current_expires_atCurrent registration term end to echo as expected_expires_at when requesting a renewal.
Available renewal choices. The total price is in EUR cents excluding VAT.
DomainStatus
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
Decision for a pending outgoing transfer.
accept Allow the domain to leave the current registrar account. |
reject Refuse the outgoing transfer request. |
DomainTransferType
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
new The domain is newly registered. |
transfer The domain is transfered in. |
unknown It is unknown how the domain ended up here. |
DomainWithNotices
idnameThe name of the domain without the top level domain.
The top level domain of the domain name, can be expanded.
domainThe full domain name.
unicode_domainThe full domain name as Unicode, this differs from domain only for internationalized domain names.
typeIndicates 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. |
statusThe 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_premiumIndicates if the domain is a premium domain which might have a higher price then normal for renewals.
is_lockedIndicates 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_enabledIndicates if the domain is automatically renewed, if not enabled the domain will expire unless manually renewed.
is_whois_privacy_enabledIndicates if the domain has WHOIS privacy enabled, when WHOIS privacy is not supported by the TLD this value will be null.
is_using_hosted_dnsIndicates if the domain us using hosted DNS from Domain Chief instead of custom nameservers, this means DNS records can be managed.
is_dnssec_enabledIndicates if the domain has DNSSEC enabled, when DNSSEC is not supported by the TLD this value will be null.
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.
The list of DNSSEC keys configured for the domain. This list will always be empty when DNSSEC is not supported.
The list of nameservers configured for the domain name.
nameserver_providerThe 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_useThe customer-supplied description of how the domain will be used when required by the registry.
renews_atThe date on which the domain will renew. Can be null if auto-renewal is disabled or the domain is not yet registered.
expires_atThe 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_priceThe 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.
mail_forward_statusThe 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_atThe date on which mail forwarding will renew. This remains set when forwarding is disabled during a paid period.
scheduled_transfer_atThe date and time at which a scheduled incoming transfer will be requested.
scheduled_transfer_locks_atThe date and time after which the transfer schedule can no longer be moved or cancelled.
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.
Restrictions currently imposed by the registry, such as a (scheduled) suspension. A restricted domain keeps its status, so check this list to find out whether an active domain is suspended. The list is empty when the domain is not restricted.
Metadata attached to the domain.
ErrorCode
Identifies why a request was rejected. 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.
dns.not_hosted The domain does not use hosted DNS, so its DNS records, snapshots, web redirects, and mail forwarding cannot be managed. Retrying will not succeed until hosted DNS is enabled again. |
dns.zone_busy Another hosted DNS change for this domain is still running. Retry the request shortly. |
dns.zone_changed The hosted DNS zone changed while the request was running. Retry the request shortly. |
dns.import.stale The zone or the import contents changed after the preview. Request a new preview before importing. |
dns.import.blocked The import would remove DNS records used by web redirects or mail forwarding. Inspect the blockers in the returned plan. |
dns.snapshot.restore_stale The zone changed after the restore preview. Request a new preview before restoring. |
dns.snapshot.automatic Automatic DNS snapshots cannot be deleted, only manual snapshots can. |
dnssec.hosted_dns DNSSEC keys are managed automatically while the domain uses hosted DNS. |
dnssec.algorithm_unsupported The TLD does not support the requested DNSSEC algorithm. |
dnssec.unsupported The TLD does not support DNSSEC. |
mail_forwarding.disabled Mail forwarding is disabled for the domain. Enable mail forwarding before managing mail forwards. |
mail_forwarding.already_disabled Mail forwarding is already disabled for the domain. |
mail_forwarding.already_enabled Mail forwarding is already enabled or still being configured for the domain. |
mail_forwarding.verification_not_failed Mail-forwarding verification can only be retried after it failed. |
domain.concurrent_request Another request for the domain is still being processed. Retry the request shortly. |
domain.already_registering The domain is already being registered. |
domain.already_owned The domain is already registered in your team. |
domain.registered_elsewhere The domain is registered in another account. Contact support for assistance. |
domain.unavailable The registry does not allow the domain to be registered or transferred. |
domain.not_searchable The domain name does not meet the naming rules of the TLD. The message explains which rule applies. |
domain.tld_unsupported The TLD is not supported. |
domain.premium The domain is a premium domain and cannot be registered or transferred through the API. |
domain.agreements_required Registry agreements must be accepted before registering domains with this TLD. The message links to the agreements page. |
domain.whois_privacy The TLD does not support WHOIS privacy. |
domain.update_not_free Updates to this domain are not free. Contact support to request the change. |
domain.lock_unsupported The domain does not support locking. |
domain.trade_required The owner contact cannot be freely changed for this TLD, a trade operation is required. |
domain.retry_registration.throttled Registration retries are rate limited. Retry after the number of seconds in the Retry-After header. |
domain.retry_registration.state_changed The domain state changed before the registration retry was accepted. Fetch the domain to inspect its current state. |
domain.dismiss_failure Only a failed domain update can be dismissed. |
auth_code.tld_unsupported The TLD of the domain does not use auth-codes. |
auth_code.not_directly_available The auth-code cannot be retrieved directly. Request the auth-code to be sent to the registrant instead. |
auth_code.directly_available The auth-code can be retrieved directly instead of being sent to the registrant. |
auth_code.throttled Auth-code requests are rate limited. Retry after the number of seconds in the Retry-After header. |
availability.auth_check_unsupported The registry does not support checking availability with an auth-code. |
availability.auth_code_invalid The registry rejected the auth-code supplied for the availability check. |
availability.registry_unavailable The registry could not be reached. Retry after the number of seconds in the Retry-After header. |
configuration.unavailable The registry configuration check could not be completed. Retry after the number of seconds in the Retry-After header. |
contact_verification.cannot_resend Contact verification cannot be resent for the domain. |
contact_verification.throttled Contact verification resends are rate limited. Retry after the number of seconds in the Retry-After header. |
transfer.auth_code_required An authorization code is required to transfer the domain. |
transfer.auth_code_incorrect The registry rejected the authorization code. |
transfer.locked The domain is locked at its current registrar. Unlock it before transferring. |
transfer.no_auth_code The transfer does not use authorization codes. |
transfer.schedule_transfer_only Only incoming transfers can be scheduled. |
transfer.schedule_auth_code_only Scheduled transfers are only available for transfers that use authorization codes. |
transfer.schedule_invoicing Scheduled transfers require a team with monthly invoicing. |
transfer.schedule_internal Scheduled transfers are not available for transfers between teams. |
transfer.schedule_move_only Only scheduled incoming transfers can be moved. |
transfer.schedule_move_locked The transfer schedule can no longer be moved because its lock time has passed. |
transfer.schedule_cancel_only Only scheduled incoming transfers can be cancelled. |
transfer.schedule_cancel_locked The transfer schedule can no longer be cancelled because its lock time has passed. |
transfer.cancel_only_failed Only failed incoming transfers can be cancelled. |
transfer.decision_recorded An outgoing transfer decision has already been recorded. |
transfer.retry_unavailable The transfer cannot be retried through the API. |
transfer.retry_throttled Transfer retries are rate limited. Retry after the number of seconds in the Retry-After header. |
transfer.retry_state_changed The domain state changed before the transfer retry was accepted. Fetch the domain to inspect its current state. |
payment.checkout_pending A pending payment is in checkout or being confirmed. Finish or wait for that payment before adding more paid operations. |
MailForward
idaliasThe local part to forward. Use * to match every otherwise unmatched address.
targetThe email address that receives forwarded messages.
MailForwardRequest
aliasThe local part to forward. Use * as a catch-all alias.
targetThe email address that receives forwarded messages.
MailForwarding
domainThe domain name configured for mail forwarding.
statusThe 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_atThe date on which the paid mail-forwarding period renews.
MailForwardingStatus
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
nameThe name of the TLD.
unicode_nameThe name of the TLD as Unicode, this differs from name only for internationalized TLDs.
handle_typesSupported domain handle types for this TLD.
transfer_typeThis 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. |
transfer_authorizationHow the current holder authorizes an incoming transfer. When this is auth_code, include the auth_code when requesting the transfer.
auth_code The transfer request must include the authorization code from the current registrar. |
registrar_tag After requesting the transfer, the registrar tag must be changed at the current registrar. The domain.transfer.incoming.registrar_tag_required notice of the domain contains the tag to set. |
none The transfer needs no authorization code or registrar tag. |
auth_code_validity_daysThe number of days an authorization code stays valid after it is requested at the current registrar, when the registry limits it. Only set when transfer_authorization is auth_code.
transfer_descriptionExplanation of how an incoming transfer is authorized for this TLD. Translated with Accept-Language. Display it as-is to the customer.
registration_priceThe 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.
renewal_priceThe 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.
transfer_priceThe 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.
is_converted_currencyIndicates 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_dnssecIndicates if the TLD supports DNSSEC.
supports_idnIndicates whether this provider supports internationalized domain names for the TLD.
minimum_label_lengthMinimum length of the canonical ASCII label, including the xn-- prefix for IDNs.
maximum_label_lengthMaximum length of the canonical ASCII label, including the xn-- prefix for IDNs.
supported_dnssec_algorithmsThe list of DNSSEC algorithms supported by the TLD.
supports_whois_privacyIndicates if the TLD supports WHOIS privacy.
whois_disclosureWhat the registry publishes about the registrant in its public WHOIS and RDAP services.
not_published The registry does not publish registrant details at all. |
individuals_not_published The registry does not publish details of individuals, but does publish details of organizations. |
individuals_email_only The registry only publishes the email address of individuals, and does publish details of organizations. |
icann_redacted Personal data is redacted by the registry and registrars under ICANN's registration data policy. |
published The registry publishes registrant details. |
unknown It is not verified what the registry publishes about the registrant. |
whois_privacy_descriptionExplanation of whether WHOIS privacy is available or needed for this TLD. Translated with Accept-Language. Display it as-is to the customer.
is_trade_requiredIndicates if the TLD requires a trade operation for owner changes.
is_auth_code_availableIndicates 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_useIndicates if registrations and transfers require a description of the intended domain use.
What the registry expects for domains under this TLD, such as who qualifies for a domain, emails the registrant must act on, required contact details and registry agreements. Empty when anyone can register a domain without further steps. Each requirement has a description to display as-is to the customer. Branch on type, operations and handle_types to decide where to show it or how to handle it. More types and operations may be added.
TLDRequirement
typeThe kind of requirement. Show the description of an unknown type as-is.
registrant_eligibility The registry checks whether the registrant qualifies for a domain under this TLD. Not every registrant can meet these criteria, and the registry can suspend or delete the domain when they do not. |
registry_email The registry emails one or more domain contacts, and they must act on that email before the operation completes or for the domain to keep working. |
contact_data The registry requires specific contact details, such as a country of residence, an identification number or a VAT number. |
contact_verification The registrant must verify their email address before a registration or transfer starts, and again when their details change. |
nameservers The registry checks the nameservers before accepting them. Every nameserver must already answer for the domain. |
intended_use A description of the intended domain use is required. |
agreement A registry agreement must be accepted. |
operationsThe domain operations this requirement applies to.
handle_typesThe domain contacts this requirement applies to, or null when it applies to all contacts.
descriptionExplanation of the requirement. Translated with Accept-Language. Display it as-is to the customer.
urlPage with more details, such as the registry's eligibility policy or the registry agreement, when available.
TLDRequirementOperation
A domain operation a TLD requirement applies to. More values may be added.
registration A new domain registration. |
transfer An incoming domain transfer. |
contact_update An update to the contacts of a domain. |
nameserver_update An update to the nameservers of a domain. |
TLDRequirementType
The kind of rule a registry applies to domains under a TLD. More values may be added, so clients should show the description of an unknown requirement as-is.
registrant_eligibility The registry checks whether the registrant qualifies for a domain under this TLD. Not every registrant can meet these criteria, and the registry can suspend or delete the domain when they do not. |
registry_email The registry emails one or more domain contacts, and they must act on that email before the operation completes or for the domain to keep working. |
contact_data The registry requires specific contact details, such as a country of residence, an identification number or a VAT number. |
contact_verification The registrant must verify their email address before a registration or transfer starts, and again when their details change. |
nameservers The registry checks the nameservers before accepting them. Every nameserver must already answer for the domain. |
intended_use A description of the intended domain use is required. |
agreement A registry agreement must be accepted. |
TLDTransferAuthorization
How the current holder authorizes an incoming transfer of a domain under this TLD. More values may be added, so clients should show the transfer description of an unknown value as-is.
auth_code The transfer request must include the authorization code from the current registrar. |
registrar_tag After requesting the transfer, the registrar tag must be changed at the current registrar. The domain.transfer.incoming.registrar_tag_required notice of the domain contains the tag to set. |
none The transfer needs no authorization code or registrar tag. |
TLDWhoisDisclosure
What a registry publishes about the registrant in its public WHOIS and RDAP services. More values may be added, so clients should treat unknown values as unknown.
not_published The registry does not publish registrant details at all. |
individuals_not_published The registry does not publish details of individuals, but does publish details of organizations. |
individuals_email_only The registry only publishes the email address of individuals, and does publish details of organizations. |
icann_redacted Personal data is redacted by the registry and registrars under ICANN's registration data policy. |
published The registry publishes registrant details. |
unknown It is not verified what the registry publishes about the registrant. |
TeamEvent
idStable identifier for this event.
typeThe 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.requested A manual domain renewal was requested. This event is billable. |
domain.renewal.request_cancelled An unpaid manual renewal request was cancelled. |
domain.renewal.failed A manual renewal was rejected by the registrar. |
domain.renewal.succeeded Domain renewal succeeded. Domain expiry date has been extended at the registry. Automatic renewals are 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.restorable Domain was deleted at the registry and is restorable until the restore period ends, after which it is permanently deleted. |
domain.deleted Domain was permanently deleted at the registry and is no longer manageable within Domain Chief. Recorded once, when the domain is deleted without a restore period or when its restore period ends. |
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. This event is billable. |
domain.restore.request_cancelled Domain restoration request was cancelled before it was sent to the registrar. |
domain.restore.succeeded Domain was restored at the registry and is manageable within Domain Chief again. |
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.registry.suspension_scheduled The registry scheduled the domain for suspension, for example because the registrant must validate their identity or registration data. |
domain.registry.suspension_cancelled The registry cancelled the scheduled suspension of the domain. |
domain.registry.suspended The registry suspended the domain, a suspended domain does not resolve. |
domain.registry.reinstated The registry lifted the suspension of the domain. |
domain.registry.on_hold The registry placed the domain on hold. |
domain.registry.on_hold_removed The registry removed the hold from the domain. |
domain.registry.seized The registry seized the domain. |
domain.registry.seizure_removed The registry lifted the seizure of the domain. |
domain.imported Domain was created outside Domain Chief and imported to be managed, no prior history is available. |
The resource this event relates to. Nested resources include the domain that owns them so you can select the matching domain-scoped endpoint.
Related activity ID, or the full activity when requested through expand[]=activity. This is null when the event has no related activity.
occurred_atTime at which the event occurred.
TeamEventResourceType
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
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.requested A manual domain renewal was requested. This event is billable. |
domain.renewal.request_cancelled An unpaid manual renewal request was cancelled. |
domain.renewal.failed A manual renewal was rejected by the registrar. |
domain.renewal.succeeded Domain renewal succeeded. Domain expiry date has been extended at the registry. Automatic renewals are 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.restorable Domain was deleted at the registry and is restorable until the restore period ends, after which it is permanently deleted. |
domain.deleted Domain was permanently deleted at the registry and is no longer manageable within Domain Chief. Recorded once, when the domain is deleted without a restore period or when its restore period ends. |
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. This event is billable. |
domain.restore.request_cancelled Domain restoration request was cancelled before it was sent to the registrar. |
domain.restore.succeeded Domain was restored at the registry and is manageable within Domain Chief again. |
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.registry.suspension_scheduled The registry scheduled the domain for suspension, for example because the registrant must validate their identity or registration data. |
domain.registry.suspension_cancelled The registry cancelled the scheduled suspension of the domain. |
domain.registry.suspended The registry suspended the domain, a suspended domain does not resolve. |
domain.registry.reinstated The registry lifted the suspension of the domain. |
domain.registry.on_hold The registry placed the domain on hold. |
domain.registry.on_hold_removed The registry removed the hold from the domain. |
domain.registry.seized The registry seized the domain. |
domain.registry.seizure_removed The registry lifted the seizure of the domain. |
domain.imported Domain was created outside Domain Chief and imported to be managed, no prior history is available. |
WebRedirect
idsubdomainThe subdomain being redirected. When the subdomain is null the root domain is redirected.
include_wwwIndicates if the www subdomain is redirected together with the root domain. Always false for subdomain redirects.
status_codeThe status code used for the redirect.
targetThe target URL of the redirect.
include_pathIndicates if the path should be appended to the target URL.
include_queryIndicates if the query string should be appended to the target URL.