JSON Responses to RESTful URL Queries for
RIRsAmerican Registry for Internet Numbers3635 Concorde ParkwayChantillyVAUS20151andy@arin.nethttp://www.arin.netRIPE Network Coordination CentreSingel 258AmsterdamNL1016ABkranjbar@ripe.nethttp://www.ripe.netLatin American and Caribbean Internet Address
RegistryRambla Republica de Mexico 6125MontevideoUY11300aservin@lacnic.nethttp://www.lacnic.netAsia Pacific Network Information Center6 Cordelia StreetSouth BrisbaneAustraliaQLD 4101bje@apnic.nethttp://www.apnic.net This document describes responses in the JSON format to the RESTful queries
described in draft-newton-et-al-weirds-rir-query. The Regional Internet Registries (RIRs) have begun experimenting with RESTful web
services for access to Whois data. RIR-QUERY presents
uniform patterns which may be used to contruct URLs for accessing data from these
RESTful web services. This document describes responses in the JSON serialization
format to the query URLs in RIR-QUERY. As this document describes responses returned in JSON format, other documents may
describe responses in other formats to the same URL queries.
This document describes the URL patterns for a Number Resource Registry Data
Access Protocol (NRRD-AP) and describes a Registry Data Access Protocol (RD-AP)
adhering to , the intent
being a specification for number resource registries useful and in the style
similar to other registry access protocols, such as Domain Name Registry Access
Protocols (DNRP-AP).
Of specific note, the signalling for JSON, JSON naming scheme, and normalized
references to other specifications are documented in
.
With specific regards to JSON format signalling, this document defines and
registers the media type "application/nrrdap+json", and conformance to this
specification is level 0. The JSON value for to be used within the rdapConformance
array is "nrrdap_level_0".
As specified in RIR-QUERY, queries for resources and information
can be made for three types of information: 1) information about IP networks,
2) information about autonomous system numbers, and 3) information about reverse DNS
delegations. Queries for each of these three types can be constructed to target
specific information:
operator information (e.g. "/operator")contacts of the operator (e.g "/operator/contacts")specific types of contacts of the operator (e.g. "/operator/contacts/abuse")registration information about the networks, AS numbers, or DNS delegations (e.g. "/registration")all of the above (e.g. "/")
Unless otherwise stated, data types of the values listed in this section are
referenced in .
The following is an elided example of a JSON response object
to a query for both registration and operator information of an IP network
{
"network":
{
...
},
"operator":
{
...
}
}
The "network" member, which may be queried for directly as the registration
information (i.e. "/registration") of the IP network is described below.The following is an example of the JSON object for the network
registration information
{
"handle" : "XXXX-RIR",
"startAddress" : "10.0.0.0",
"endAddress" : "10.0.0.255",
"ipVersion" : 4,
"name": "NET-RTR-1",
"description" : [ "A network used for routing" ],
"type" : "DIRECT ALLOCATION",
"country" : "AU",
"parentHandle" : "YYYY-RIR",
"remarks" : [
"she sells seas shells",
"down by the seashore"
],
"uris" : [
{
"type" : "source",
"uri" : "http://whois-rws.net/network/xxxx"
},
{
"type" : "parent",
"uri" : "http://whois-rws.net/network/yyyy"
},
{
"type" : "held",
"uri" : "http://example.net/location/xxxx"
}
],
"registrationDate" : "20110509",
"lastChangedDate" : "20110509",
"lastChangedBy" : "joe@bob.com"
}
The following is a description of the members of this object:
-- a string representing an RIR unique identifier of the
network registration-- the starting IP address of the network,
either IPv4 or IPv6-- the ending IP address of the network, either IPv4 or IPv6-- an integer signifying the IP protocol version of the
network: 4 signifying an IPv4 network, 6 signifing an IPv6 network-- an identifier assigned to the network registration
by the registration holder-- an array of strings containing descriptive text about the
network registration-- a string containing an RIR specific classification
of the network-- a string containing the name of the 2 character country code
of the network
-- a string containing an RIR unique identifier of the
parent network of this network registration
The members "remarks", "uris", "registrationDate", "lastChangedDate", and
"lastChangedBy" take the same form of the members of the same name of the
entity object.
The "operator" member of , which maybe queried for directly
using the "/operator" path, is described below.The following is an elided example of a JSON response object
for operator information
{
"entity":
{
...
},
"contacts":
{
"tech": [
...
],
"admin": [
...
],
"abuse": [
...
]
}
}
The "entity" member of is an object and is specified in
. The "contacts" member is an object containing three
arrays: "tech", "admin", and "abuse". Each of these arrays contains
entities. That is, the "tech" array contains entity
objects, each representing a tech contact, etc...
An autonomous number query for both the registration and operator and/or contact information yields
an object containing an "autnum" member and an "operator" member. The "operator"
member is as specified in . Additionally,
queries specifically for the operator and/or contact information take the same
form as in .The "autnum" member mentioned above as well as queries directly for the
registration information take the form of a JSON object.The following is an example of a JSON object representing
an autnum.
{
"handle" : "XXXX-RIR",
"startAutnum" : "10",
"endAutnum" : "15",
"name": "AS-RTR-1",
"description" : [ "AS for Exchange" ],
"type" : "DIRECT ALLOCATION",
"country": "AU",
"remarks" : [
"she sells seas shells",
"down by the seashore"
],
"uris" : [
{
"type" : "source",
"uri" : "http://whois-rws.net/autnum/xxxx"
},
{
"type" : "parent",
"uri" : "http://whois-rws.net/autnum/yyyy"
},
{
"type" : "held",
"uri" : "http://example.net/location/xxxx"
}
],
"registrationDate" : "20110509",
"lastChangedDate" : "20110509",
"lastChangedBy" : "joe@bob.com"
}
The following is a description of the members of this object:
-- a string representing an RIR unique identifier of the
autnum registration-- the starting number in the block of autonomous system numbers-- the ending number in the block of autonomous system numbersan identifier assigned to the autnum registration
by the registration holder-- an array of strings containing descriptive text about the
autnum registration-- a string containing an RIR specific classification
of the autnum-- a string containing the name of the 2 character country code of
the autnum
The members "remarks", "uris", "registrationDate", "lastChangedDate", and
"lastChangedBy" take the same form of the members of the same name of the
entity object.
A reverse DNS delegation query for both the registration and operator and/or contact information yields
an object containing an "rdns" member and an "operator" member. The "operator"
member is as specified in . Additionally,
queries specifically for the operator and/or contact information take the same
form as in .The "rdns" member mentioned above as well as queries directly for the
reverse DNS information take the form of a JSON object.The following is an example of a JSON object representing
an reverse DNS delegation.
{
"handle" : "XXXX-RIR",
"name" : "192.in-addr.arpa",
"nameServers" : [ "ns1.rir.net", "ns2.rir.net" ],
"delegationKeys" : [
{
"algorithm": 7,
"digest" : "E68C017BD813B9AE2F4DD28E61AD014F859ED44C",
"digestType" : 1,
"keyTag" : 53814
}
],
"remarks" : [
"she sells seas shells",
"down by the seashore"
],
"uris" : [
{
"type" : "source",
"uri" : "http://whois-rws.net/network/xxxx"
},
{
"type" : "parent",
"uri" : "http://whois-rws.net/network/yyyy"
},
{
"type" : "held",
"uri" : "http://example.net/location/xxxx"
}
],
"registrationDate" : "20110509",
"lastChangedDate" : "20110509",
"lastChangedBy" : "joe@bob.com"
}
The following is a description of the members of this object:
-- a string representing an RIR unique identifier of the
reverse DNS delegation-- a string denoting the DNS zone name, which is a domain name-- an array of strings, each being a fully qualified DNS
name of a namesever-- an array of objects, each with the following
members:
-- an integer as specified by the algorithm field
of a DNS DS record as specified by RFC 4034 in presentation format-- an string as specified by the digest field
of a DNS DS record as specified by RFC 4034 in presentation format-- an integer as specified by the digest type field
of a DNS DS record as specified by RFC 4034 in presetnation format-- an integer as specified by the key tag field
of a DNS DS record as specified by RFC 4034 in presentation format
The members "remarks", "uris", "registrationDate", "lastChangedDate", and
"lastChangedBy" take the same form of the members of the same name of the
entity object.
Throughout this document there is a need to represent the identity and contact
information of organizations, corporations, governments, non-profits, clubs,
individual persons, and informal groups of people. All of these representations are
so similar that it is best to represent them in JSON with one construct, the entity
object, to aid in the re-use of code by implementers.The following is an example of an entity:
{
"handle" : "XXXX-RIR",
"names": [ "Joe Bob, Inc.", "Bobby Joe Shopping" ],
"postalAddress" : [
"123 Maple Ave",
"Suite 90001",
"Vancouver",
"BC",
"12393"
],
"emails" : [ "joe@bob.com", "bob@joe.com" ],
"phones" : {
"office" : [ "999-999-999-99", "111-111-111-11" ],
"fax" : [ "222-222-222-22" ],
"mobile" : [ "333-333-333-33" ]
},
"remarks" : [
"she sells seas shells",
"down by the seashore"
],
"uris" : [
{
"type" : "source",
"uri" : "http://whois-rws.net/contact/xxxx"
},
{
"type" : "held",
"uri" : "http://example.net/location/xxxx"
}
],
"registrationDate" : "20110509",
"lastChangedDate" : "20110509",
"lastChangedBy" : "joe@bob.com"
}
This object as the following members. -- a string representing an RIR unique identifier of the
entity-- an array of strings, each signifying the name of the
entity-- an array of string, each representing a line
in a postal address.-- an array of strings, each containing an email address for
the entity-- an object containg telephone information associated with
the entity, with the following members: -- an array of strings, each being a telephone
number-- an array of strings, each being a telephone number-- an array of strings, each being a telephone
number-- an array of strings, each containing comments about the
entity-- an array of objects, each object having the following
members: -- a string denoting the application type of the "uri"
value-- a string containing a URI-- a string containing the date the entity was
registered-- a string containing the date of last change made
to the entity-- a string containing an identifier of the party
responsible for the last change made to the entity registration This specification registers the "application/nrrdap+json" media type. Type name: applicationSubtype name: nrrdap+jsonRequired parameters: n/aOptional parameters: levelEncoding considerations: n/aSecurity considerations: n/aInteroperability considerations: n/aPublished specification: [[ this document ]]Applications that use this media type: RESTful Whois applicationsAdditional information: n/aPerson & email address to contact for further information: Andy Newton
&andy@hxr.us&Intended usage: COMMONRestrictions on usage: noneAuthor: Andy NewtonChange controller: IETFA Uniform RESTful URL Query Pattern for RIRsThis document describes uniform patterns for which to construct HTTP URLs
that may be used to retreive information from Regional Internet
Registries (RIRs) using "RESTful" web access patterns.The application/json Media Type for JavaScript Object Notation
(JSON)JavaScript Object Notation (JSON) is a lightweight, text-based,
language-independent data interchange format. It was derived from the
ECMAScript Programming Language Standard. JSON defines a small set of
formatting rules for the portable representation of structured data.
This memo provides information for the Internet community.Resource Records for the DNS Security ExtensionsThis document is part of a family of documents that describe the DNS
Security Extensions (DNSSEC). The DNS Security Extensions are a
collection of resource records and protocol modifications that provide
source authentication for the DNS. This document defines the public key
(DNSKEY), delegation signer (DS), resource record digital signature
(RRSIG), and authenticated denial of existence (NSEC) resource records.
The purpose and format of each resource record is described in detail,
and an example of each resource record is given. This document obsoletes RFC 2535 and incorporates changes from all
updates to RFC 2535. [STANDARDS-TRACK]Textual Representation of Autonomous System (AS) NumbersA textual representation for Autonomous System (AS) numbers is defined as the decimal value of the AS number. This textual representation is to be used by all documents, systems, and user interfaces referring to AS numbers. [STANDARDS-TRACK]Uniform Resource Identifier (URI): Generic SyntaxWorld Wide Web ConsortiumMassachusetts Institute of Technology77 Massachusetts AvenueCambridgeMA02139USA+1-617-253-5702+1-617-258-5999timbl@w3.orghttp://www.w3.org/People/Berners-Lee/Day Software5251 California Ave., Suite 110IrvineCA92617USA+1-949-679-2960+1-949-679-2972fielding@gbiv.comhttp://roy.gbiv.com/Adobe Systems Incorporated345 Park AveSan JoseCA95110USA+1-408-536-3024LMM@acm.orghttp://larry.masinter.net/
Applications
uniform resource identifierURIURLURNWWWresource
A Uniform Resource Identifier (URI) is a compact sequence of characters
that identifies an abstract or physical resource. This specification
defines the generic URI syntax and a process for resolving URI references
that might be in relative form, along with guidelines and security
considerations for the use of URIs on the Internet.
The URI syntax defines a grammar that is a superset of all valid URIs,
allowing an implementation to parse the common components of a URI
reference without knowing the scheme-specific requirements of every
possible identifier. This specification does not define a generative
grammar for URIs; that task is performed by the individual
specifications of each URI scheme.
Hypertext Transfer Protocol -- HTTP/1.1Department of Information and Computer
ScienceUniversity of California, IrvineIrvineCA92697-3425+1(949)824-1715fielding@ics.uci.eduWorld Wide Web ConsortiumMIT Laboratory for Computer Science, NE43-356545 Technology SquareCambridgeMA02139+1(617)258-8682jg@w3.orgCompaq Computer CorporationWestern Research Laboratory250 University AvenuePalo AltoCA94305mogul@wrl.dec.comWorld Wide Web ConsortiumMIT Laboratory for Computer Science, NE43-356545 Technology SquareCambridgeMA02139+1(617)258-8682frystyk@w3.orgXerox CorporationMIT Laboratory for Computer Science, NE43-3563333 Coyote Hill RoadPalo AltoCA94034masinter@parc.xerox.comMicrosoft Corporation1 Microsoft WayRedmondWA98052paulle@microsoft.comWorld Wide Web ConsortiumMIT Laboratory for Computer Science, NE43-356545 Technology SquareCambridgeMA02139+1(617)258-8682timbl@w3.org The Hypertext Transfer Protocol (HTTP) is an application-level protocol
for distributed, collaborative, hypermedia information systems. It is a
generic, stateless, protocol which can be used for many tasks beyond its
use for hypertext, such as name servers and distributed object
management systems, through extension of its request methods, error
codes and headers . A feature of HTTP is the typing and negotiation of
data representation, allowing systems to be built independently of the
data being transferred. HTTP has been in use by the World-Wide Web global information initiative
since 1990. This specification defines the protocol referred to as
"HTTP/1.1", and is an update to RFC 2068 . Using HTTP for RESTful Whois Services by Internet RegistriesThis document describes the use of HTTP in Whois services using RESTful web methodologies.