Need help? Call Live Support at +31 (0) 38 453 07 59

Attention! You're currently using the OT&E environment.

Tld info

Used to get TLD metadata.

  • GETMethod
  • /v2/tlds/tld/infoURL
URL fields
Name Type Description Restrictions
TLD String The tld without any dot (.)

Successful request

TLD metadata has been retrieved successfully
  • 200 OKHTTP Status
  • application/jsonContent-Type
Response fields
Name Type Required / Optional Description
Provider name String Required The provider which offers this tld
Applicable extensions List <String> Required Domain extensions which have the same metadata, may contain multiple levels (e.g. "es" and "com.es")
metadata metadata Required The metadata for the TLD
metadata
Name Type Required / Optional Description
Create domain periods List <Integer> Required List of supported periods with domain creation
Renew domain periods List <Integer> Required List of supported periods with domain renewal
Auto renew domain periods List <Integer> Required List of supported periods for automatic domain renewal
Transfer domain periods List <Integer> Optional List of supported periods with domain transfer
The redemption period Integer Optional The period in which a deleted domain can be restored
The pending delete period Integer Optional Domain deletion confirmation awaited by the registry
The grace period on a domain create Integer Optional The period in which a domain may be deleted and a conditional refund can be claimed
The grace period on a renew Integer Optional The period in which a renewed domain may be deleted and a conditional refund can be claimed
The grace period on an auto renew Integer Optional The period in which an auto renewed domain may be deleted and a conditional refund can be claimed
The grace period on a transferred domain Integer Optional The period in which a transferred domain may be deleted and a conditional refund can be claimed
The expiry date offset Integer Optional The offset for the expiry date when the automatical domain renewal is started in seconds
Transfer FOA applicable for domain Boolean Required Whether or not the transfer process requires accepting of FOA
Adjustable auth code Boolean Required Whether or not the auth code can be auto regenerated
Customizable auth code Boolean Required Whether or not the auth code can be customized
Transfer supports auth code Boolean Required Whether or not the transfer process supports an auth code
Transfer requires auth code Boolean Required Whether or not the transfer process requires an auth code
If true then the domain will only get created after the registrant has been validated Boolean Required Whether or not the domain creation is dependent on the registrant being validated
Zone check from String Optional Set if a zone check is performed by the registry, contains the url to the check form at the registry
Possible client domain statuses List <Enum> Optional Supported client domain statuses

Possible values:

  • CLIENT_HOLD: Client hold
  • CLIENT_DELETE_PROHIBITED: Client delete prohibited
  • CLIENT_UPDATE_PROHIBITED: Client update prohibited
  • CLIENT_RENEW_PROHIBITED: Client renew prohibited
  • CLIENT_TRANSFER_PROHIBITED: Client transfer prohibited
  • IRTPC_TRANSFER_PROHIBITED: IRTP-C transfer prohibited
Allowed DNSSec records Integer Optional Maximum number of allowed DNSSec record types
DNSSec algorithms List <Integer> Optional The supported DNSSEC algoriths

Possible values:

  • 3: 3 (DSA/SHA1)
  • 5: 5 (RSA/SHA-1)
  • 6: 6 (DSA-NSEC3-SHA1)
  • 7: 7 (RSASHA1-NSEC3-SHA1)
  • 8: 8 (RSA/SHA-256)
  • 10: 10 (RSA/SHA-512)
  • 12: 12 (GOST R 34.10-2001)
  • 13: 13 (ECDSA Curve P-256 with SHA-256)
  • 14: 14 (ECDSA Curve P-384 with SHA-384)
  • 15: 15 (Ed25519)
  • 16: 16 (Ed448)
  • 17: 17 (SM2 signing algorithm with SM3 hashing algorithm)
  • 23: 23 (GOST R 34.10.2012)
Validation category Enum Optional If validation is required, the required validation category

Possible values:

  • General: General terms and conditions
  • IisNu: .NU registry terms and conditions
  • IisSe: .SE registry terms and condition
  • ESNic: .ES registry terms and condition
  • Nominet: .UK registry terms and condition
  • DkHostmaster: .dk registry terms and condition
Features available List <Enum> Required Features available

Possible values:

  • CREATE: Create is supported for the TLD
  • RENEW: Explicit renew is supported by the registry. For registries that do not support explicit renewal we allow domains te be renewed up one month in advance of expiry.
  • TRANSFER: Transfer is supported for the TLD
  • RESTORE: Restore is supported for the TLD
  • UPDATE: Update is supported for the TLD
  • PRIVACY_PROTECT: Privacy protect is supported for the TLD
  • PUSH_TRANSFER: Push transfer support is supported for the TLD
  • LOCAL_CONTACT: A local contact is available for the TLD
Registrant change requires approval Boolean Required Material changes to registrant date require IRTP-C approval.
Registrant change transfer lock Boolean Required The domain will be locked for transfer after registrant change
Allows designated agent Enum Optional when registrant change requires approval, indicates the allowed designated agent type. When type is "BOTH", you can also use only "OLD" or "NEW"

Possible values:

  • NONE
  • OLD
  • NEW
  • BOTH
Jurisdiction String Optional Applicable jurisdiction to for registrations
Terms of service String Optional Link to registry terms of service applicable to registrations
Privacy policy String Optional Link to registry privacy policy applicable to registrations
Registration notice String Optional Notice that must be shown to the registrant during registration
Whois exposure Enum Required Indication of the data publicly exposed over whois, port 43 and web

Possible values:

  • NONE: No personal data is publicly exposed
  • LIMITED: For personal registrations data is not exposed, avoid using personal data in organizational contacts
  • FULL: All data is exposed
  • UNKNOWN: Situation unknown
GDPR category Enum Required Categorization specific to GDPR compliance

Possible values:

  • EU_BASED: Registrations are in EU jurisdiction
  • ADEQUACY: Registrations are in a jurisdiction that provides an adequate level of data protection according to the EU.
  • DATA_EXPORT: Registrations are in a jurisdiction without an adequate level of data protection as outlined by the EU. Fundamental rights like the right to be forgotten or erasure do not apply.
  • UNKNOWN: Situation unknown
Restore includes renewal Boolean Required Indicates if the restore fee of a domain includes the renewal fee or this is charged separately when necessary.
Renewal on transfer Enum Required Indicates if a renewal is charged when a transfer is initiated

Possible values:

  • NO_CHANGE: After transfer of domain, the expiry date remains the same
  • RENEW_UNLESS_GRACE: After transfer the domain is renewed and expiry date is extended by one year, unless the domain is in (auto) renew grace period
  • RENEWAL: After transfer, the domain is renewed and the expiry date is extended by 1 year
  • NEW_PERIOD: After transfer, the domain life cycle is reset. The new expiry date is the transfer completion date plus the transfer period.
domainSyntax domainSyntax Required Specific requirements for the domain name
nameservers nameservers Required Specific requirements for the name servers
hosts hosts Required Specific requirements for the hosts
registrant registrant Required Requirements for the registrant
adminContacts adminContacts Required Requirements for the admin contact(s)
billingContacts billingContacts Required Requirements for the billing contact(s)
techContacts techContacts Required Requirements for the tech contact(s)
contactProperties List < contactProperties > Optional Available contact properties
launchPhases List < launchPhases > Optional Available launch phases
contactProperties
Name Type Required / Optional Description
Name String Required The name of the property
Label String Required The textual label for the property
Description String Required The textual description of the property
Field type Enum Required Data type of property

Possible values:

  • String
  • Date
  • Integer
Mandatory Boolean Required Whether or not the property is mandatory
Values Map <String, String> Optional When restricted to a fixed set of values, a map of the allowed values with their textual description
launchPhases
Name Type Required / Optional Description
Phase String Required Name of the launch phase
Start date Timestamp Optional
End date Timestamp Optional
domainSyntax
Name Type Required / Optional Description
minLength Integer Required
maxLength Integer Required
idnSupport Boolean Required
idnType Enum Optional

Possible values:

  • IDNA2003: idna2003
  • IDNA2008: idna2008
  • UTS46: uts46
  • UTS46_2003: uts46_2003
  • UTS46_2003_TRANSITIONAL: uts46_2003_transitional
allowedCharacters String Optional
languageCodes languageCodes Optional
languageCodes
Name Type Required / Optional Description
name String Required
allowedCharacters String Optional
nameservers
Name Type Required / Optional Description
Minimum amount Integer Required Minimum amount of entries to be supplied
Maximum amount Integer Required Minimum amount of entries to be supplied
Required Boolean Required It is possible that a value is not required but there is a minumum specified, this means that if a value is supplied it should have at least the minumum amount
hosts
Name Type Required / Optional Description
addressesIPv4 addressesIPv4 Required Specific requirements for the IPv4 host addresses
addressesIPv6 addressesIPv6 Required Specific requirements for the IPv6 host addresses
addressesTotal addressesTotal Required Specific requirements for the total amount of host addresses
addressesIPv4
Name Type Required / Optional Description
Minimum amount Integer Required Minimum amount of entries to be supplied
Maximum amount Integer Required Minimum amount of entries to be supplied
addressesIPv6
Name Type Required / Optional Description
Minimum amount Integer Required Minimum amount of entries to be supplied
Maximum amount Integer Required Minimum amount of entries to be supplied
addressesTotal
Name Type Required / Optional Description
Minimum amount Integer Required Minimum amount of entries to be supplied
Maximum amount Integer Required Minimum amount of entries to be supplied
registrant
Name Type Required / Optional Description
Organization required Boolean Required Is the contact is required to be an organization
Organization allowed Boolean Required Is the contact allowed to be an organization
Allowed countries List <String> Optional The countries allowed for the contact
Scope of contact usage Enum Required The scope for the usage usage of this contact

Possible values:

  • REGISTRY: Contact is created and used at the registry
  • REGISTRY_PARTIAL: Contact is created and used at the registry with a subset of fields
  • REGISTRAR: Contact is only used at the registrar and not exposed to the registry
  • IGNORED: Contact is non defined by policy and is functionally ignored
adminContacts
Name Type Required / Optional Description
Minimum amount Integer Required Minimum amount of entries to be supplied
Maximum amount Integer Required Minimum amount of entries to be supplied
Required Boolean Required It is possible that a value is not required but there is a minumum specified, this means that if a value is supplied it should have at least the minumum amount
Organization required Boolean Required Is the contact is required to be an organization
Organization allowed Boolean Required Is the contact allowed to be an organization
Allowed countries List <String> Optional The countries allowed for the contact
Scope of contact usage Enum Required The scope for the usage usage of this contact

Possible values:

  • REGISTRY: Contact is created and used at the registry
  • REGISTRY_PARTIAL: Contact is created and used at the registry with a subset of fields
  • REGISTRAR: Contact is only used at the registrar and not exposed to the registry
  • IGNORED: Contact is non defined by policy and is functionally ignored
billingContacts
Name Type Required / Optional Description
Minimum amount Integer Required Minimum amount of entries to be supplied
Maximum amount Integer Required Minimum amount of entries to be supplied
Required Boolean Required It is possible that a value is not required but there is a minumum specified, this means that if a value is supplied it should have at least the minumum amount
Organization required Boolean Required Is the contact is required to be an organization
Organization allowed Boolean Required Is the contact allowed to be an organization
Allowed countries List <String> Optional The countries allowed for the contact
Scope of contact usage Enum Required The scope for the usage usage of this contact

Possible values:

  • REGISTRY: Contact is created and used at the registry
  • REGISTRY_PARTIAL: Contact is created and used at the registry with a subset of fields
  • REGISTRAR: Contact is only used at the registrar and not exposed to the registry
  • IGNORED: Contact is non defined by policy and is functionally ignored
techContacts
Name Type Required / Optional Description
Minimum amount Integer Required Minimum amount of entries to be supplied
Maximum amount Integer Required Minimum amount of entries to be supplied
Required Boolean Required It is possible that a value is not required but there is a minumum specified, this means that if a value is supplied it should have at least the minumum amount
Organization required Boolean Required Is the contact is required to be an organization
Organization allowed Boolean Required Is the contact allowed to be an organization
Allowed countries List <String> Optional The countries allowed for the contact
Scope of contact usage Enum Required The scope for the usage usage of this contact

Possible values:

  • REGISTRY: Contact is created and used at the registry
  • REGISTRY_PARTIAL: Contact is created and used at the registry with a subset of fields
  • REGISTRAR: Contact is only used at the registrar and not exposed to the registry
  • IGNORED: Contact is non defined by policy and is functionally ignored

Failed requests

Generic errors can be expected.

URL fields
The tld without any dot (.)
Request

GET /v2/tlds/tld/info

Response