ActivityCauser
idThe unique identifier of the causer. Is null when the activity was caused by Domain Chief itself.
typeuser The activity was caused by a user. |
team The activity was caused by a team. |
system The activity was caused by the system itself. |
deleted The activity was caused by a deleted user or team. |
nameThe name of the causer.
via_apiIndicates whether the action was performed via the API.
ActivityCauserType
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. |
deleted The activity was caused by a deleted user or team. |
ActivitySubject
idThe unique identifier of the subject.
typedomain The activity subject is a domain. |
nameThe name of the subject.
permalinkContact
handleThe parent contact of this contact. When expanded, contains the full contact object.
company_namefirst_namelast_namecompany_registration_numbervat_registrationaddress_streetaddress_house_numberaddress_postal_codeaddress_cityaddress_country_codeCountry code in ISO 3166-1 alpha-2 format.
emailphonePhone numbers are in international format.
is_defaultIndicates if the contact is the default contact for the team.
Metadata attached to the contact.
ContactEmailVerificationStatus
pending A verification e-mail has been sent to the email address for verification, waiting on user action. |
verified The e-mail address is verified. |
DNSRecord
idtypenameThe record name. When empty the record is for the root domain. This never includes the domain name itself.
contentThe record content.
ttlThe record TTL.
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.
Metadata attached to the record.
DnssecKey
public_keyPublic key for the DNSSEC key.
algorithm1 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 |
flags256 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 |
Domain
idThe top level domain of the domain name, can be expanded.
nameThe name of the domain without the top level domain.
domainThe full domain name.
typenew The domain is newly registered. |
transfer The domain is transfered in. |
unknown It is unknown how the domain ended up here. |
statusactive The domain is registered. |
failed There was a problem completing the registration or transfer. |
deleted The domain is deleted (either manually of because it was expired). |
requested The domain registration or transfer has been requested and is being processed. |
restorable The domain has been deleted at the registry but is still restorable by the user. |
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.
The list of DNSSEC keys configured for the domain. This list will always be empty when DNSSEC is not supported.
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 nameservers configured for the domain name.
nameserver_providerrenews_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.
Metadata attached to the domain.
DomainActivity
ideventdomain.registration.requested Domain registration was requested. This event is billable. |
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.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.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.renewal.succeeded Domain renewal succeeded. Domain expiry date has been extended at the registry. This event is billable. |
domain.deleted Domain was deleted at the registry and is no longer manageable within Domain Chief. |
domain.expired Domain was marked as expired, domain is still restorable until deletion at the registry. |
domain.update.nameservers Domain nameservers were updated (can include old and new values). |
domain.update.lock_enabled Domain transfer lock was enabled. |
domain.update.lock_disabled Domain transfer lock was disabled. |
domain.update.whois_privacy_enabled Domain WHOIS privacy was enabled. |
domain.update.whois_privacy_disabled Domain WHOIS privacy was disabled. |
domain.update.auto_renew_enabled Domain auto-renewal was enabled. |
domain.update.auto_renew_disabled Domain auto-renewal was disabled. |
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.hosted_dns_enabled Domain hosted DNS was enabled. |
domain.update.hosted_dns_disabled Domain hosted DNS was disabled. |
domain.update.mail_forward_enabled Domain e-mail forwarding was enabled. |
domain.update.mail_forward_disabled Domain e-mail forwarding was disabled. |
domain.transfer.internal Domain was transferred between providers within Domain Chief, this event is purely informational. |
domain.imported Domain was created outside Domain Chief and imported to be managed, no prior history is available. |
descriptionA textual description of this activity.
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.
DomainActivityEvent
domain.registration.requested Domain registration was requested. This event is billable. |
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.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.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.renewal.succeeded Domain renewal succeeded. Domain expiry date has been extended at the registry. This event is billable. |
domain.deleted Domain was deleted at the registry and is no longer manageable within Domain Chief. |
domain.expired Domain was marked as expired, domain is still restorable until deletion at the registry. |
domain.update.nameservers Domain nameservers were updated (can include old and new values). |
domain.update.lock_enabled Domain transfer lock was enabled. |
domain.update.lock_disabled Domain transfer lock was disabled. |
domain.update.whois_privacy_enabled Domain WHOIS privacy was enabled. |
domain.update.whois_privacy_disabled Domain WHOIS privacy was disabled. |
domain.update.auto_renew_enabled Domain auto-renewal was enabled. |
domain.update.auto_renew_disabled Domain auto-renewal was disabled. |
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.hosted_dns_enabled Domain hosted DNS was enabled. |
domain.update.hosted_dns_disabled Domain hosted DNS was disabled. |
domain.update.mail_forward_enabled Domain e-mail forwarding was enabled. |
domain.update.mail_forward_disabled Domain e-mail forwarding was disabled. |
domain.transfer.internal Domain was transferred between providers within Domain Chief, this event is purely informational. |
domain.imported Domain was created outside Domain Chief and imported to be managed, no prior history is available. |
DomainAvailability
free Domain is available for registration |
owned Domain is owned by the authenticated team |
active Domain is registered, may be transferable |
error An error has occured retrieving availability |
DomainAvailabilityResult
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.
availabilityfree Domain is available for registration |
owned Domain is owned by the authenticated team |
active Domain is registered, may be transferable |
error An error has occured retrieving availability |
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.
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
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. |
restorable The domain has been deleted at the registry but is still restorable by the user. |
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. |
TLD
nameThe name of the TLD.
handle_typesSupported domain handle types for this TLD.
transfer_typeextend The expiration date is extended with the time you have paid for at the outgoing registrar + a renewal period (usually 1 year). This is the most comoon. |
unchanged The current expiration date is kept unchanged on transfer, this usually means the transfer is free. |
restart The expiration date is reset and any remaining time you might have paid for at the outgoing registrar is lost. |
registration_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.
supported_dnssec_algorithmsThe list of DNSSEC algorithms supported by the TLD.
supports_whois_privacyIndicates if the TLD supports WHOIS privacy.
WebRedirect
idsubdomainThe subdomain being redirected. When the subdomain is null the www subdomain is implied.
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.