TldResponse

Successful response with one Tld

errorintegerrequired

Always 0 in a successful response

Constant value: 0

messagestring | nullnullablerequired

Always null in a successful response

data objectrequired

TLD (domain extension), with the rules for the names and for the contacts of its domains

tld_idintegerrequired

extensionstringrequired

Extension without the leading dot, in Unicode (for example it or co.uk)

punycodestringrequired

Extension in punycode

country objectrequired

Country of the TLD, for the country-code TLDs (ccTLD); null for the others

anyOf

• Country
• null

iso_code_2stringrequired

ie. IT

iso_code_3stringrequired

ie. ITA

country_namestringrequired

Name of the country in Italian; the local name when there is no translation

local_namestringrequired

Name of the country in its own language, for example Deutschland

phone_codestringrequired

International calling code, without +, for example 39

continentstringrequired

Continent, in English, for example Europe or North America

regionstringrequired

Area of the country: EU (European Union) or EXTRAEU

char_mininteger | nullnullablerequired

Minimum length of the name, without the extension

char_maxinteger | nullnullablerequired

Maximum length of the name, without the extension

hyphen_allowedbooleanrequired

Whether the name can contain hyphens

number_allowedbooleanrequired

Whether the name can contain numbers

punycode_allowedbooleanrequired

Whether the name can contain international characters (IDN)

dnssec_enabledbooleanrequired

Whether the TLD supports DNSSEC

rdap_enabledbooleanrequired

Whether the availability of the names is checked with RDAP

rdap_urlstring | nullnullablerequired

URL of the RDAP service used for the TLD; null when not set

contact_data object[]required

Fields of the contact data of the domains of the TLD, with their type and allowed values (the authcode excluded)

Array [

namestringrequired

Code of the contact specification

typestringrequired

Data type of the specification value

enumstring[]nullablerequired

If not null, the list of allowed values for this specification

]

update_contact_rboolean | nullnullablerequired

Whether the registrant contact (R) can be changed (PATCH /api/v3/domains/{domain_id}/contacts/{domain_contact_id})

update_contact_aboolean | nullnullablerequired

Whether the administrative contact (A) can be changed

update_contact_tboolean | nullnullablerequired

Whether the technical contact (T) can be changed

update_contact_oboolean | nullnullablerequired

Whether the organization contact (O) can be changed

update_contact_additionalbooleanrequired

Whether a change of the contacts must also send the additional data of the TLD to the registry

update_contact_transferbooleanrequired

Whether a transfer must also send the additional data of the TLD to the registry

transfer_authcodebooleanrequired

Whether the transfer of a domain of the TLD requires the authcode

metarequired

Always null: only the paginated lists have a meta

Constant value: null

TldResponse

{
  "error": 0,
  "message": "string",
  "data": {
    "tld_id": 0,
    "extension": "string",
    "punycode": "string",
    "country": {
      "iso_code_2": "string",
      "iso_code_3": "string",
      "country_name": "string",
      "local_name": "string",
      "phone_code": "string",
      "continent": "string",
      "region": "string"
    },
    "char_min": 0,
    "char_max": 0,
    "hyphen_allowed": true,
    "number_allowed": true,
    "punycode_allowed": true,
    "dnssec_enabled": true,
    "rdap_enabled": true,
    "rdap_url": "string",
    "contact_data": [
      {
        "name": "string",
        "type": "string",
        "enum": "Unknown Type: array,null"
      }
    ],
    "update_contact_r": true,
    "update_contact_a": true,
    "update_contact_t": true,
    "update_contact_o": true,
    "update_contact_additional": true,
    "update_contact_transfer": true,
    "transfer_authcode": true
  }
}