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

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

Get domain

Used to get a domain

  • GETMethod
  • /v2/domains/domainNameURL
URL fields
Name Type Description Restrictions
domainName String The domain name
  • Regular expression: ^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+(?:[a-z][a-z0-9-]{0,61}[a-z0-9])$
  • Minimum length: 3
  • Maximum length: 255
  • Registry specific restrictions may apply
Request parameters
Name Type Required / Optional Description Restrictions
fields String Optional Select fields to include in the response, comma separated list of field names. Requesting only the needed fields improves response time, especially when omitting relation fields. Identifying field(s) are always included.

Successful request

Domain has been retrieved successfully
  • 200 OKHTTP Status
  • application/jsonContent-Type
Response fields
Name Type Required / Optional Description
domainName String Required The domain name
registry String Required The registry of the domain name
customer String Required The customer handle
registrant String Required The handle of the registrant contact
privacyProtect Boolean Required Privacy protect enabled
status List <Enum> Required The domain status

Possible values:

  • OK: Ok
  • INACTIVE: Inactive
  • PENDING_TRANSFER: Pending transfer
  • PENDING_RENEW: Pending renew
  • PENDING_UPDATE: Pending update
  • DELETE_REQUESTED: Delete requested
  • PENDING_DELETE: Pending delete
  • ADD_PERIOD: Add period
  • RENEW_PERIOD: Renew period
  • AUTO_RENEW_PERIOD: Auto renew period
  • TRANSFER_PERIOD: Transfer period
  • REDEMPTION_PERIOD: Redemption period
  • PENDING_RESTORE: Pending restore
  • 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
  • REGISTRAR_HOLD: Registrar hold
  • REGISTRAR_DELETE_PROHIBITED: Registrar delete prohibited
  • REGISTRAR_UPDATE_PROHIBITED: Registrar update prohibited
  • REGISTRAR_RENEW_PROHIBITED: Registrar renew prohibited
  • REGISTRAR_TRANSFER_PROHIBITED: Registrar transfer prohibited
  • SERVER_HOLD: Server hold
  • SERVER_DELETE_PROHIBITED: Server delete prohibited
  • SERVER_UPDATE_PROHIBITED: Server update prohibited
  • SERVER_RENEW_PROHIBITED: Server renew prohibited
  • SERVER_TRANSFER_PROHIBITED: Server transfer prohibited
  • PENDING_VALIDATION: Domain pending registrant validation
  • PRIVACY_PROTECT_PROHIBITED: Privacy protect prohibited
  • EXPIRED: Domain has expired
  • IRTPC_TRANSFER_PROHIBITED: Transfer prohibited due to IRTP-C
authcode String Optional The auth code of the domain name
languageCode String Optional For IDN domains, the TLD specific language code of the domain name
autoRenew Boolean Required If set to False, the domain will not be auto renewed upon expiration
autoRenewPeriod Integer Required Auto renewal period in months
ns List <String> Optional List of name servers used by the domain name
childHosts List <String> Optional List of child hosts created under the domain name
createdDate Timestamp Required The date the domain was created
updatedDate Timestamp Optional The date the domain was last updated
expiryDate Timestamp Required The expiry date of the domain name
premium Boolean Required If set to True, the domain is a premium domain where extra fees apply
gateway Boolean Required If set to True, the domain registered trough the gateway service
zone zone Optional
contacts List < contacts > Optional Domain contacts and their role
keyData List < keyData > Optional DNSSEC Key data for domain
dsData List < dsData > Optional DNSSEC DS data for domain.
zone
Name Type Required / Optional Description
id Integer Required ID of the DNS zone
service Enum Required The type of DNS service

Possible values:

  • BASIC: Basic, free DNS
  • PREMIUM: Premium DNS
template String Optional Name of the template
dnssec Boolean Required Whether or not DNSSEC is enabled
master String Optional IP address of the (hidden) master
contacts
Name Type Required / Optional Description
role Enum Required The role for the contact

Possible values:

  • ADMIN
  • BILLING
  • TECH
handle String Required The contact handle
keyData
Name Type Required / Optional Description
protocol Integer Required The DNSSEC protocol

Possible values:

  • 3
flags Integer Required The DNSSEC flags

Possible values:

  • 256: 256 (ZSK)
  • 257: 257 (KSK)
algorithm Integer Required The DNSSEC algorithm

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)
publicKey String Required The base64 encoded public key
dsData
Name Type Required / Optional Description
keyTag Integer Required The DNSSEC keyTag
algorithm Integer Required The DNSSEC algorithm

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)
digestType Integer Required The DNSSEC digest type

Possible values:

  • 1: 1 (SHA-1)
  • 2: 2 (SHA-256)
  • 3: 3 (GOST R 34.11-94)
  • 4: 4 (SHA-384)
digest String Required The digest of the public key

Failed requests

Generic errors can be expected.

URL fields
The domain name
Request parameters
Select fields to include in the response, comma separated list of field names. Requesting only the needed fields improves response time, especially when omitting relation fields. Identifying field(s) are always included.
Request

GET /v2/domains/domainName

Response