REST Resource: domain

Resource: RdapDomain

Domain object as defined in section 5.3 of RFC 7483. Missing "variants", "publicIds", "network" from the spec.

JSON representation
{
  "objectClassName": string,
  "handle": string,
  "ldhName": string,
  "unicodeName": string,
  "nameservers": [
    {
      object (RdapNameserver)
    }
  ],
  "secureDNS": {
    object (SecureDns)
  },
  "entities": [
    {
      object (RdapEntity)
    }
  ],
  "status": [
    string
  ],
  "remarks": [
    {
      object (Remark)
    }
  ],
  "links": [
    {
      object (Link)
    }
  ],
  "port43": string,
  "events": [
    {
      object (Event)
    }
  ],
  "jsonResponse": {
    object (HttpBody)
  },
  "rdapConformance": [
    string
  ],
  "notices": [
    {
      object (Notice)
    }
  ],
  "lang": string,
  "errorCode": number,
  "title": string,
  "description": [
    string
  ]
}
Fields
objectClassName

string

Should always be set to the string "domain".

handle

string

A string representing a registry unique identifier of the domain object instance.

ldhName

string

A string describing a domain name in LDH form as described in section 3 of RFC 7483.

unicodeName

string

A string containing a domain name with U-labels as described in section 3 of RFC 7483.

nameservers[]

object (RdapNameserver)

An array of nameserver objects.

secureDNS

object (SecureDns)

The name of this field is a workaround so it formats to a JSON field with the name "secureDNS".

entities[]

object (RdapEntity)

Contact entities of this domain.

status[]

string

List of statuses applied to the entity. Example: "update prohibited".

remarks[]

object (Remark)

Remarks related to the domain.

port43

string

WHOIS server for this domain. Example: "whois.g.u.00rz.com".

events[]

object (Event)

Events affecting this domain.

jsonResponse

object (HttpBody)

HTTP response with content type set to "application/json+rdap".

rdapConformance[]

string

RDAP conformance level. Should only be filled if the domain is a top-level object of a response.

notices[]

object (Notice)

Notices relating to the domain. Should only be filled if the domain is a top-level object of a response.

lang

string

Error language code. Error response info fields defined in section 6 of RFC 7483.

errorCode

number

Error HTTP code. Example: "501".

title

string

Error title.

description[]

string

Error description.

RdapNameserver

Nameserver object as defined in section 5.2 of RFC 7483. Missing "handle", "entities", "status", "remarks", "links", "port43", "events" from the spec.

JSON representation
{
  "objectClassName": string,
  "ldhName": string,
  "unicodeName": string,
  "ipAddresses": [
    {
      object (IpAddressObject)
    }
  ]
}
Fields
objectClassName

string

Should always be set to the string "nameserver".

ldhName

string

A string representing a registry unique identifier of the nameserver as described in section 3 of RFC 7483.

unicodeName

string

A string containing a DNS Unicode name of the nameserver as described in section 3 of RFC 7483.

ipAddresses[]

object (IpAddressObject)

IP addresses of this nameserver.

IpAddressObject

JSON representation
{
  "v4": [
    string
  ],
  "v6": [
    string
  ]
}
Fields
v4[]

string

An array of strings containing IPv4 addresses of the nameserver.

v6[]

string

An array of strings containing IPv6 addresses of the nameserver.

SecureDns

DNS data of the domain. Missing "events", "links" from the spec.

JSON representation
{
  "zoneSigned": boolean,
  "delegationSigned": boolean,
  "maxSigLife": number,
  "dsData": [
    {
      object (DsData)
    }
  ],
  "keyData": [
    {
      object (KeyData)
    }
  ]
}
Fields
zoneSigned

boolean

True if the zone has been signed, false otherwise.

delegationSigned

boolean

True if there are DS records in the parent, false otherwise.

maxSigLife

number

Represents the signature lifetime in seconds to be used when creating the RRSIG DS record in the parent zone.

dsData[]

object (DsData)

DNS DS records as described by RFC 4034.

keyData[]

object (KeyData)

DNSKEY records of the domain as specified by RFC 4034.

DsData

JSON representation
{
  "keyTag": number,
  "algorithm": number,
  "digest": string,
  "digestType": number
}
Fields
keyTag

number

The key tag field of a DNS DS record.

algorithm

number

Algorithm field of a DNS DS record.

digest

string

Digest field of a DNS DS record.

digestType

number

Digest type field of a DNS DS record.

KeyData

Missing "events", "links" from the spec.

JSON representation
{
  "flags": number,
  "protocol": number,
  "publicKey": string,
  "algorithm": number
}
Fields
flags

number

Flags field value in the DNSKEY record as specified by RFC 4034.

protocol

number

The protocol field value of the DNSKEY record as specified by RFC 4034.

publicKey

string

Public key in the DNSKEY record as specified by RFC 4034.

algorithm

number

Algorithm field of a DNSKEY record as specified by RFC 4034.

RdapEntity

Entity object as defined in section 5.1 of RFC 7483. Missing "asEventActor", "networks", "autnums" from spec.

JSON representation
{
  "objectClassName": string,
  "handle": string,
  "vcardArray": [
    value
  ],
  "roles": [
    string
  ],
  "publicIds": [
    {
      object (PublicId)
    }
  ],
  "entities": [
    {
      object (RdapEntity)
    }
  ],
  "status": [
    string
  ],
  "remarks": [
    {
      object (Remark)
    }
  ],
  "links": [
    {
      object (Link)
    }
  ],
  "port43": string,
  "events": [
    {
      object (Event)
    }
  ]
}
Fields
objectClassName

string

Should always be set to the string "entity".

handle

string

A string representing a registry unique identifier of the entity.

vcardArray[]

value (Value format)

A jCard with the entity's contact information

roles[]

string

An array of strings, each signifying the relationship an object would have with its closest containing object.

publicIds[]

object (PublicId)

Public ID of the entity, if present.

entities[]

object (RdapEntity)

Entities can also have other entities embedded with them in an array. This can be used to model an organization with specific individuals fulfilling designated roles of responsibility.

We use this to represent an abuse contact: entities with role "registrar" inside a domain object should have an internal entity object with role "abuse" and a corresponding vCard with phone and email addresses of the abuse contact.

status[]

string

List of statuses applied to the entity. Example: "private".

remarks[]

object (Remark)

Remarks relating to the entity.

port43

string

WHOIS server for this domain. Example: "whois.g.u.00rz.com".

events[]

object (Event)

Events that have occurred on this entity.

PublicId

Public IDs defined in section 4.8 of RFC 7483.

JSON representation
{
  "type": string,
  "identifier": string
}
Fields
type

string

Type of ID. Example: "IANA Registrar ID".

identifier

string

Text of the ID. Example: "1".

Remark

Remarks object defined in section 4.3 of RFC 7483.

JSON representation
{
  "type": string,
  "title": string,
  "description": [
    string
  ],
  "links": [
    {
      object (Link)
    }
  ]
}
Fields
type

string

Type values as per section 10.2.1 of RFC 7483 specific to a single object: "object truncated due to authorization", "object truncated due to excessive load", "object truncated due to unexplainable reasons", "object redacted due to authorization".

title

string

Title of the remark.

description[]

string

Actual text of the remark.

Event

Events object defined in section 4.5 of RFC 7483.

JSON representation
{
  "eventAction": string,
  "eventDate": string,
  "eventActor": string,
  "links": [
    {
      object (Link)
    }
  ]
}
Fields
eventAction

string

Action that occurred in this event. Example: "registration".

eventDate

string (Timestamp format)

Timestamp of the event. Example: "1990-12-31T23:59:59Z".

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

eventActor

string

Handle of event actor. Example: "SOMEID-LUNARNIC". However, there is one type of event that must not have the eventActor. For information about that type of event, see section 5.1 of RFC 7483.

Methods

get

Look up RDAP information for a domain by name.