Update Api

The RDAP data can be updated by Update API.

Introduction Of Usage

• All Update API prefix: /u/
• Content type must be 'application/rdap+json' or 'application/json', in 'Content-Type' header.
• URI and parameters must be encoded in UTF-8.
• Unknown parameters will be ignored.
• Support IP authentication: request from out of IP white list is not allowed.
• Request and Response body is in JSON format.
• About 'handle': Should be in [ASCII - _].
• Max length of columns: for 'handle' value is 100, all others is 255 if not specified in the following tables.

common request format

create

• HTTP METHOD : POST
• URI : /u/{objectType}
  objectType：domain、nameserver、ip、autnum、entity
• CONTENT TYPE : 'application/rdap+json' or 'application/json'
• BODY : JSON formatted key-value parameters.

update

• HTTP METHOD : PUT
• URI : /u/{objectType}/{handle}
  handle：object handle
• CONTENT TYPE : 'application/rdap+json' or 'application/json'
• BODY : the same with 'create'

delete

• HTTP METHOD : DELETE
• URI : /u/{objectType}/{handle}
  handle：object handle

common response format

HTTP status code	service code	body	desc
200		{"handle":"xxx"}	success response
not 200		{"handle":"domain-1", "errorCode":400, "subErrorCode":4002, "description":[" Property can’t be empty:ldhName"]}	failure response

response code

HTTP status code	service code	description
200		success response
400	4001	Request data is not valid JSON, or has invalid date type
400	4002	Property can't be empty
400	4003	Property exceed max length
400	4007	Property must be valid date
400	4008	Property value is not valid
400	4009	Unrecognized request URI
400	40010	Property value must between [xx,xx]
403	4031	Forbidden
404	4041	Object not found with handle
409	4091	Object already exist for handle
405		method not allowed
415		unsupported media type
500		internal server error

create/update body parameter

Common parameter

All update API can has these parameters:

name	type	length/range	not empty	desc
handle	string	1-100	Y	registry-unique identifiers referenced an object. Should be ASCII and '-'/'_'.
entities	array		N	arrays of inner-entity object
status	array	0-20	N	status array, each status length must be [0-20]. e.g: [“validated”,”redacted”]
remarks	array		N	arrays of remark object
links	array		N	arrays of link object
events	array		N	arrays of event object
lang	string	0-64	N	Language Identifier, e.g: "en"
port43	string	0-4096	N	Port 43 WHOIS Server
customProperties	object		N	e.g: {"customKey1":"value1","customKey2":"value2" }

inner-object

name	type	length/range	not empty	desc
handle	string	1-100	Y	object handle. Non-exist handle will be ignored.

inner-entity

name	type	length/range	not empty	desc
handle	string	1-100	Y	entity handle. Non-exist handle will be ignored.
roles	array		N	e.g: [“registrant”, “administror”]

remark or notice

name	type	not empty	desc
title	string	N	title of the object
description	array	N	each description length must be [0-2048]
links	array	N	arrays of link object

link

name	type	not empty	desc
value	string	N	[0-2048]. e.g: "http://example.com/context_uri"
rel	string	N	e.g: "self"
href	string	N	e.g: "http://example.com/target_uri"
hreflang	array	N	e.g: [ "en", "ch" ]
title	string	N	http://tools.ietf.org/html/rfc5988#section-5
media	string	N	e.g: "screen"
type	string	N	e.g: "application/json"

publicId

name	type	not empty	desc
type	string	N	a string denoting the type of public identifier
identifier	string	N	a public identifier of the type denoted by 'type'

event

name	type	not empty	desc
eventAction	string	Y	a string denoting the reason for the event
eventActor	string	N	denoting the actor responsible for the event
eventDate	string	Y	UTC date time. Format must be like: 2015-01-01T01:01:01Z
links	array	N	arrays of link object

Domain

name	type	not empty	desc
ldhName	string	Y	puny name of domain. Can't contain last '.' of domain. Must be lowercased.
unicodeName	string	N	[0,1024]. unicode name of domain. If is ASCII domain then it is the same with ldhName
variants	array	N	array of variant object
nameservers	array	N	arrays of inner-object object
secureDNS	object	N	secureDNS object
publicIds	array	N	arrays of publicId, e.g: [{"type":"IANA Registrar ID", "identifier":"1"}]
type	string	N	"dnr" for DNR domain, or "arpa" for ARPA domain
networkHandle	string	N	network handle for ARPA domain. This value will be ignored if network not exist.

variant

name	type	not empty	desc
relation	array	N	array of relation string. e.g: [ "registered", "conjoined" ]
idnTable	string	N	the name of the IDN table of codepoints
variantNames	array	N	array of variantName object

variantName

name	type	not empty	desc
ldhName	string	N	variant's ldhName.Can't contain last '.' of domain. Must be lowercased.
unicodeName	string	N	variant's unicodeName

secureDNS

name	type	not empty	desc
zoneSigned	boolean	N	true if the zone has been signed, false otherwise.
delegationSigned	boolean	N	boolean true if there are DS records in the parent, false otherwise.
maxSigLife	int	N	the signature life time in seconds to be used when creating the RRSIG DS record
dsData	array	N	array of dsData object
keyData	array	N	array of keyData object

dsData

name	type	not empty	desc
keyTag	int	Y	the key tag field of a DNS DS record as specified by RFC 4034
algorithm	int	Y	the algorithm field of a DNS DS record as described by RFC 4034
digest	string	Y	[0-2048]. the digest field of a DNS DS record as specified by RFC 4034
digestType	int	Y	the digest type field of a DNS DS record as specified by RFC 4034
links	array	N	arrays of link object
events	array	N	arrays of event object

keyData

name	type	not empty	desc
flags	int	Y	the flags field value in the DNSKEY record as specified by RFC 4034
protocol	int	Y	the protocol field value of the DNSKEY record as specified by RFC 4034
publicKey	string	N	the public key in the DNSKEY record as specified by RFC 4034
algorithm	int	Y	the algorithm field of a DNSKEY record as specified by RFC 4034
links	array	N	arrays of link object
events	array	N	arrays of event object

Nameserver

name	type	not empty	desc
ldhName	string	Y	puny name of nameserver. Can't contain last '.' of domain. Must be lowercased.
unicodeName	string	N	[0,1024]. If is ASCII nameserver then it is the same with ldhName
ipAddresses	object	N	ipAddresses object

ipAddresses

name	type	not empty	desc
ipList	array	N	arrays of IP. IP can be v4 or v6. e.g: [“218.1.1.1”, “2001:db8::”]

Entity

name	type	length/range	not empty	desc
fn	string		Y	entity name
kind	string		N	http://tools.ietf.org/html/rfc6350#section-6.1.4
email	string		N	email
title	string		N	http://tools.ietf.org/html/rfc6350#section-6.6.1
org	string		N	org
url	string	0-4096	N	http://tools.ietf.org/html/rfc6350#section-6.7.8
addresses	array		N	array of address object
telephones	array		N	array of telephone telephones
publicIds	array		N	the same with domain

address

name	type	not empty	desc
pref	string	N	http://tools.ietf.org/html/rfc6350#section-5.3
types	string	N	multiple type string separated by ';'. http://tools.ietf.org/html/rfc6350#section-5.6
postbox	string	N	postbox
extendedAddress	string	N	the extended address
streetAddress	string	N	street address
locality	string	N	the locality. e.g: city
region	string	N	the region. e.g:state or province
postalcode	string	N	the postal code
country	string	N	the country name

telephone

name	type	not empty	desc
pref	string	N	http://tools.ietf.org/html/rfc6350#section-5.3
types	string	N	string of type for multiple http://tools.ietf.org/html/rfc6350#section-5.6, separated by';'
number	string	Y	telephone number
extNumber	string	N	extended number

Network

name	type	not empty	desc
startAddress	string	Y	the starting number in the block of network
endAddress	string	Y	the ending number in the block of network
ipVersion	string	N	'v4' or 'v6'. This value will not affect the real type for startAddress and endAddress.
name	string	N	an identifier assigned to the network registration by the registration holder
type	string	N	a string containing an RIR-specific classification of the network
country	string	N	a string containing the two-character country code of the network
parentHandle	string	N	parent network of this network registration
cidr	string	Y	formatted network used to generate self link for query. http://tools.ietf.org/html/rfc4632. e.g: 92.168.99.0/24

As number

name	type	not empty	desc
startAutnum	string	Y	the starting number in the block of autonomous system numbers
endAddress	string	Y	the ending number in the block of autonomous system numbers
name	string	N	an identifier assigned to the autnum registration by the registration holder
type	string	N	a string containing an RIR-specific classification of the autnum
country	string	N	a string containing the name of the 2 character country code of the autnum