Search Responses
Responses to RDAP searches use a named array that matches the object class found in the array.
Array Name | Object Class |
---|---|
domainSearchResults | domain |
nameserverSearchResults | nameserver |
entitySearchResults | entity |
Note that each search result is required to have a rdapConformance
array
and may have a notices
array.
Domain Search Results
Domain search results are the proper response to a domain search query:
{
"rdapConformance": [ "rdap_level_0" ],
"domainSearchResults" : [
{
"objectClassName" : "domain",
"handle" : "result_1",
"ldhName" : "1.com"
// ...
},
{
"objectClassName" : "domain",
"handle" : "result_2",
"ldhName" : "2.com"
// ...
}
]
}
Nameserver Search Results
Nameserver search results are the proper response to a nameserver search query:
{
"rdapConformance": [ "rdap_level_0" ],
"nameserverSearchResults" : [
{
"objectClassName" : "nameserver",
"handle" : "result_1",
"ldhName" : "ns1.foo.com"
// ...
},
{
"objectClassName" : "nameserver",
"handle" : "result_2",
"ldhName" : "ns2.foo.com"
// ...
}
]
}
Entity Search Results
Entity search results are the proper response to an entity search query:
{
"rdapConformance": [ "rdap_level_0" ],
"entitySearchResults" : [
{
"objectClassName" : "entity",
"handle" : "entity_1",
// ...
},
{
"objectClassName" : "entity",
"handle" : "entity_2",
// ...
}
]
}
Other Common Data Structures in Search Results
RFC 9083 is a bit light on the
details of search results and there are a few of the common data structures
that make sense to be included in a search result in addition to the rdapConformance
.
Specifically, those would be links
, notices
,
and events
.
{
"rdapConformance": [ "rdap_level_0" ],
"nameserverSearchResults" : [
{
"objectClassName" : "nameserver",
"handle" : "result_1",
"ldhName" : "ns1.foo.com"
// ...
},
{
"objectClassName" : "nameserver",
"handle" : "result_2",
"ldhName" : "ns2.foo.com"
// ...
}
],
"notices" :
[
{
"title" : "Terms of Service",
"description" :
[
"This data is covered under some terms."
]
}
],
"events" :
[
{
"eventAction" : "last update of RDAP database",
"eventActor" : "A_REGISTRY",
"eventDate" : "1990-12-31T23:59:59Z",
}
]
}