Download - NUS_API_XML

7/31/2019 NUS_API_XML

1/154

Neustar, Inc.46000 Center Oak PlazaSterling, VA 20166Phone : (888) 367-4820www.neustarultraservices.biz/

Transaction ProtocolVersion 3.0

Neustar, Inc.

December 8, 2009
http://www.neustarultraservices.biz/http://www.neustarultraservices.biz/


2/154

This document is for informational purposes only. NEUSTAR MAKES NOWARRANTIES, EXPRESS, IMPLIED, OR STATUTORY, AS TO THEINFORMATION IN THIS DOCUMENT.

Complying with all applicable copyright laws is the responsibility of theuser. Without limiting the rights under copyright, no part of this documentmay be reproduced, stored in or introduced into a retrieval system, or

transmitted in any form or by any means (electronic, mechanical,photocopying, recording, or otherwise), or for any purpose, without theexpress written permission of Neustar.

Neustar may have patents, patent applications, trademarks, copyrights, orother intellectual property rights covering subject matter in this document.Except as expressly provided in any written license agreement fromNeustar, the furnishing of this document does not give you any license tothese patents, trademarks, copyrights, or other intellectual property.

Unless otherwise noted, the example companies, organizations, products,domain names, e-mail addresses, logos, people, places, and eventsdepicted herein are fictitious, and no association with any real company,organization, product, domain name, email address, logo, person, place, orevent is intended or should be inferred.

2009 Neustar, Inc. All rights reserved.

Neustar Ultra Services is a trademark and UltraCare is a service mark ofNeustar in the United States and other countries. Other Neustar UltraServices graphics and logos are also trademarks or service marks ofNeustar. Our trademarks and service marks may not be used (1) inconnection with any product or service that is not an offering of NeustarUltra Services, unless we have given express written permission to so useour trademarks or service marks, or (2) in any manner that is likely tocause confusion among customers, or disparages or discredits Neustar.

All other trademarks and/or service marks identified or referenced are theproperty of their respective owners and subject to their usagerequirements.


3/154

Table of Contents

Introduction ............................................................................................................................ 1Document Revisions .......... .......... ........... .......... ........... .......... .......... ........... .......... ........... ...... 1Important Notes ...................................................................................................................... 1Protocol Overview .................................................................................................................. 3Assumptions .......................................................................................................................... 4Protocol Design ...................................................................................................................... 5

Request Definition ............................................................................................... 5Response Definition ............................................................................................ 6Parameter Types ................................................................................................. 7XML-RPC Extensions .......................................................................................... 8DNS-Related Data Types .................................................................................. 10DTD (Document Type Definition) ...................................................................... 18

Requests (Method Calls) ..................................................................................................... 21Advanced Requests ........... .......... ........... .......... ........... .......... .......... ........... .......... ........... .. 135

ACLs (User and Group-based Permissions) ................................................... 135Directional ........................................................................................................ 143

Error codes ......................................................................................................................... 1471999 ............................................................................................................... 14710001999 ....................................................................................................... 14720002999 ....................................................................................................... 149

Sample Session Script ...................................................................................................... 150References .......................................................................................................................... 151


4/154

Neustar Ultra Services Transaction Protocol

1

Introduction

This document specifies the Neustar Ultra Services transaction protocol version 3.0. This protocolenables customers to:

manage objects remotely in the Neustar Ultra Services database

provide an alternative to the Neustar Ultra Services Management utility

Document Revisions

Date Page(s) History of Changes

2008-09-03 70, 84, 95, 118 Added two requests:

o UDNS_CreateResourceRecord

o UDNS_DeleteResourceRecord

Moved two requests from the Special Request section to the Standard

Request section:

o UDNS_FindResourceRecords

o UDNS_GetZoneInfo

2009-02-26 72, 134, 147 ModifiedUDNS_CreateSecondaryZone

AddedUDNS_UpdateZonePrimarySources

Added errors 1065 and 1066 toError codes

2009-03-04 119 AddedUDNS_GetZonePrimarySources

2009-07-15 68 Added forceImport argument toUDNS_CreatePrimaryZone

2009-07-27 147 Added error codes 167, 168, and 169 toError codes.

2009-08-19 68 Fixed orthographical error.

2009-09-28 150

152 Added error codes 9, 1043

1049, 1061, 2006, 2007; removed error codes

121, 10011005, 1007, 1008, 1010, 1011, 1014, 1019, 1050, 1052, 1055,

1060, 1062, 2005.

2009-12-08 Removed UDNS_GetASNForRecord, UDNS_GetASNList, andUDNS_SetASNForRecord requests.

Renamed:

UDNS_GetDirectionalMaskForRecord toUDNS_GetBasicDirectionalServers

UDNS_GetDirectionalServerList toUDNS_GetBasicDirectionalServerListUDNS_SetDirectionalMaskForRecord toUDNS_SetBasicDirectionalServers

Important Notes

XML RPC Specification Differences

Neustars implementation of the XML RPC differs from thespecificationin three ways:

1. Uses SSL as the transport mechanism (instead of HTTP)

2. Defines and uses several extensions to the standard XML-RPC protocol
http://www.xmlrpc.com/spechttp://www.xmlrpc.com/spechttp://www.xmlrpc.com/spechttp://www.xmlrpc.com/spec


5/154


2

3. Is not compatible with standard XML-RPC clients

SeeProtocol Designon page5for more information.

Hostname and Port Number

Contact Neustar Ultra Services Technical Support ([email protected], (888) 367-4820, or(517) 434-5358) to obtain the current hostname and port number.

Sample Session Script

SeeSample Session Scripton page150for a test script that you can modify for your environment.
mailto:[email protected]:[email protected]:[email protected]:[email protected]


6/154


3

Protocol Overview

The protocol follows a client-server model. A remote client sends requests and a server respondswith results of the requests. The server daemon runs on Neustar machines. Neustar providescustomers with a prototype client that they can use or modify. This client connects to the serverand sends requests for the user specified operations. The server performs the required operationsand returns either the result of the operation or an error message. Clients can only send requests tothe server. The server only sends responses.

The server stores only a limited amount of state information while the connection is open. Theserver loses all state information about a client when the connection is closed. Even when theconnection is open, the server saves only the client authentication information. It discards allinformation about a request once it sends the response back to the client.

The secure protocol, SSL, connects the client and the server. SSL insures authenticity andconfidentiality of the data. The client must have an open SSL connection and send an openconnection request with a username and password to a specified API server (name/IP and port).

The server authenticates the client using the username and password provided and sends anappropriate response to client. If the client authentication succeeds, the connection remains openand the client can send additional requests to the server. On authentication failure, the servercloses the connection after sending the response. The server also performs an access control checkof the client using its IP address to see if it exists in the servers allowed list.

The Neustar Ultra Services Transaction Protocol supports ADD, DELETE, READ, and MODIFYrecord requests.


7/154


4

Assumptions

Neustar Ultra Services designed the protocol and the API server with the following assumptions:

1. The protocol and API server do not include a failover capability. However, using a suitable

deployment strategyfor example, running the API server on multiple machines andusing DNS round robin, can substitute for failover.

2. The API server assumes a connection is always available to at least one Oracle server froma list of Oracle servers. Otherwise, the server does not accept client connections.


8/154


5

Protocol Design

Neustar based the protocol on XML, which offers the following advantages:

Standard meta-language

Ease of transferring structured data

Wide acceptance

Depth of language and parser support

Note: Neustars implementation of the XML RPC differs from thespecificationin three

ways:1. Uses SSL as the transport mechanism (instead of HTTP)2. Defines and uses several extensions to the standard XML-RPC protocol

3. Is not compatible with standard XML-RPC clients

Request Definition

In general, a XML-RPC request has the form:

add_new_user

41

The first line is a XML header. The request consists of only one top-level entity, . The must contain a sub-item string that contains the name of the methodto be called. The string may only contain identifier characters, upper and lower-case A-Z, thenumeric characters, 0-9, underscore, dot, colon, and slash. It is entirely up to the server to decidehow to interpret the characters in a .

If the procedure call has parameters, the must contain a sub-item. The sub-item can contain any number of entities, each of which has a .

Note: It is important to base each entity on the correct value.
http://www.xmlrpc.com/spechttp://www.xmlrpc.com/spechttp://www.xmlrpc.com/spechttp://www.xmlrpc.com/spec


9/154


6

Response Definition

The general form of a XML-RPC response is:

www.example.com.

Like the request, the first line is an XML header.

The body of the response is a single XML structure, a , which can contain asingle that contains a single , which contains a single .

Method succeeded

To return multiple values as part of a response, the single can contain a of type (discussed later in this document).

The could also contain a which contains a which is a containing two elements, one named , an and one named, a . The server uses to inform the client of any error conditionswhile processing the request.

Below is an example of a with a :

faultCode

4

faultString

Bad Format


10/154


7

Parameter Types

XML-RPC has a set predefined data types that describes the type of the parameter. These typesare:

Integer (4 byte signed)

Unsigned (4 byte unsigned integer)

Boolean (0-false, 1-true)

String (ASCII string)

Double (double precision signed float)

DateTime (iso8601 format)

base64 (for base 64 encoded data)

XML-RPC supports arrays via the tag. An contains a single element,which can contain any number of s. Here is an example of a four-element array:

12

Egypt

0

-31

The elements do not have names. XML-RPC allows the mixing of different types ofvalues as shown above.

XML-RPC also allows users to define their own data type via the tags.

FirstName

John

LastName

Doe

Age

25


11/154


12/154


9

The use of the entity is optional. A client can send individual entitiesbut it will have to open a connection to the server, send one , wait for a response,and close the connection. It will have to follow the above steps for all transactions it wants toperform. Doing this has the disadvantage of a performance hit for opening and closing SSLconnections. However, it is a simple approach and ideal if the client has to interact with the serveroccasionally. Enclosing all transactions in a entity has better performance because the

client can open a SSL connection, open a session (by sending a tag), send a, process its response, send the next , process its response, and so ontill all its transactions are completed. Then close the session by sending a tag and closethe SSL connection. This approach is ideal if the client wants to perform bulk operations againstthe server.

Phase 2 extends the XML-RPC response format to allow the server to enclose multiple entities in a single new entity: (note the slight difference inspelling between the two). is of the form:

...

...


13/154


10

DNS-Related Data Types

16 bit unsigned integer data

32-bit number that has a fractional part

String containing a fully qualified hostname

Maximum length: 256 characters

String containing a fully qualified zone name


Note: The FQDN for the zone must include a trailing dot to be unambiguous. For example,

www.example.com.

String containing a valid IPv4 dotted quad address

Allowed characters 19 and .


String containing a valid IPv6 address

Full version or shorthand notation allowed


14/154


11

Start of Authority (SOA) record with the form:

zonezone.

nameserver

ns.zone.

email

email

serial

12345

refresh

10800

retry

3600

expire

604800

mincache

86400

ttl

86400


15/154


12

Name server (NS) record of the form:

servedzone

zone1.

nameserver

ns.zone1.

ttl

86400

IPv4 Address (A) record of the form:

hostname

host1.

address

192.168.1.1

ttl

86400


16/154


17/154


14

Canonical Name (CNAME) record of the form:

alias

h1.

hostname

host1.

ttl

86400

Mail Exchanger (MX) record of the form:

servedzone

zone1.

mailserver

mail.zone1.

priority

10

ttl

86400


18/154


15

Text (TXT) record of the form:

hostname

host.

content

data

ttl

86400

Delegation Signer (DS) record of the form:

hostname

host.

keytag

data

algorithm

data

digest

data


19/154


16

Responsible Person (RP) record of the form:

email

[email protected]

data

user.domain.com.

Mail forwarding record of the form:

guid

0903352110F1615B

emailhost

host.domain.com.

emailname

user

forwardhost

host2.domain2.com.


20/154


17

Web forwarding record of the form:

guid

0903352110F1615D

requesthost

host.domain.com.

requestpage

dir/page.html

targethost

host2.domain2.com.


21/154


18

DTD (Document Type Definition)

Scalar Types

(#PCDATA)>

(#PCDATA)>

(#PCDATA)>

(#PCDATA)>

(#PCDATA)>

(#PCDATA)>

(#PCDATA)>

(#PCDATA)>

(#PCDATA)>

(#PCDATA)>

(#PCDATA)>


23/154


20

Response Information

(value)>

(params|fault)>


24/154


21

Requests (Method Calls)

This document alphabetically lists all supported requests, their detailed format, and behavior.

Note: Unless a request includes a specific response example, the default response is of the

form:

UDNS_AddMailForward ....................................................................................................... 25UDNS_AddRestrictIPForAllZones ...................................................................................... 26UDNS_AddRestrictIPForZone ............................................................................................. 27UDNS_AddUserXInfo ........................................................................................................... 28UDNS_AddWebForward ...................................................................................................... 29UDNS_ChangeAliasOfCNAMERecord ................................................................................ 30UDNS_ChangeContentOfTXTRecord ................................................................................. 31UDNS_ChangeEmailOfSOARecord .................................................................................... 32UDNS_ChangeExpireLimitOfSOARecord .......................................................................... 33UDNS_ChangeHostOfAAAARecord ................................................................................... 34UDNS_ChangeHostOfARecord ........................................................................................... 35UDNS_ChangeHostOfCNAMERecord ................................................................................ 36UDNS_ChangeHostOfPTRRecord ...................................................................................... 37UDNS_ChangeHostOfTXTRecord ....................................................................................... 38UDNS_ChangeIPOfAAAARecord ........................................................................................ 39UDNS_ChangeIPOfARecord ............................................................................................... 40UDNS_ChangeIPOfPTRRecord ........................................................................................... 41UDNS_ChangeMailServerOfMXRecord .............................................................................. 42UDNS_ChangeMinimumCacheOfSOARecord ................................................................... 43UDNS_ChangeNameServerOfNSRecord............................................................................ 44UDNS_ChangeNameServerOfSOARecord ......................................................................... 45

Method succeeded


25/154


22

UDNS_ChangePriorityOfMXRecord ................................................................................... 46UDNS_ChangeRefreshIntervalOfSOARecord .................................................................... 47UDNS_ChangeRetryIntervalOfSOARecord ........................................................................ 48UDNS_ChangeSerialNumberOfSOARecord ...................................................................... 49UDNS_ChangeServedDomainOfNSRecord ....................................................................... 50UDNS_ChangeServedZoneOfMXRecord............................................................................ 51UDNS_ChangeTTLOfAAAARecord .................................................................................... 52UDNS_ChangeTTLOfARecord ............................................................................................ 53UDNS_ChangeTTLOfCNAMERecord .................................................................................. 54UDNS_ChangeTTLOfMXRecord ......................................................................................... 55UDNS_ChangeTTLOfNSRecord .......................................................................................... 56UDNS_ChangeTTLOfPTRRecord ........................................................................................ 57

UDNS_ChangeTTLOfSOARecord ....................................................................................... 58UDNS_ChangeTTLOfTXTRecord ........................................................................................ 59UDNS_ChangeUserEmail .................................................................................................... 60UDNS_ChangeUserPassword ............................................................................................. 61UDNS_CloseConnection ..................................................................................................... 62UDNS_CreateAAAARecord ................................................................................................. 63UDNS_CreateARecord ......................................................................................................... 64UDNS_CreateCNAMERecord .............................................................................................. 65UDNS_CreateMXRecord ...................................................................................................... 66UDNS_CreateNSRecord ...................................................................................................... 67UDNS_CreatePrimaryZone .................................................................................................. 68UDNS_CreatePTRRecord .................................................................................................... 69UDNS_CreateResourceRecord ........................................................................................... 70UDNS_CreateRPRecord ...................................................................................................... 71UDNS_CreateSecondaryZone ............................................................................................. 72UDNS_CreateSSHFPRecord ............................................................................................... 73UDNS_CreateTXTRecord..................................................................................................... 74UDNS_CreateUser ................................................................................................................ 75UDNS_DeleteAAAARecord ................................................................................................. 76UDNS_DeleteAllRecordsOfUser ......................................................................................... 77


26/154


23

UDNS_DeleteARecord ......................................................................................................... 78UDNS_DeleteCNAMERecord ............................................................................................... 79UDNS_DeleteMailForward ................................................................................................... 80UDNS_DeleteMXRecord ...................................................................................................... 81UDNS_DeleteNSRecord ....................................................................................................... 82UDNS_DeletePTRRecord..................................................................................................... 83UDNS_DeleteResourceRecord ........................................................................................... 84UDNS_DeleteRPRecord ....................................................................................................... 85UDNS_DeleteSSHFPRecord ................................................................................................ 86UDNS_DeleteTXTRecord ..................................................................................................... 87UDNS_DeleteUser ................................................................................................................ 88UDNS_DeleteUserXInfo ....................................................................................................... 89

UDNS_DeleteWebForward .................................................................................................. 90UDNS_DeleteZone ............................................................................................................... 91UDNS_DisableAutoSerialUpdate ........................................................................................ 92UDNS_Disconnect ............................................................................................................... 93UDNS_EnableAutoSerialUpdate ......................................................................................... 94UDNS_FindResourceRecords ............................................................................................. 95UDNS_GetAAAARecordsOfZone ........................................................................................ 96UDNS_GetAllRRsOfZone..................................................................................................... 97UDNS_GetAllZonesOfUser .................................................................................................. 99UDNS_GetARecordsOfZone ............................................................................................. 100UDNS_GetAutoSerialUpdateState .................................................................................... 101UDNS_GetCNAMERecordsOfZone ................................................................................... 102UDNS_GetMXRecordsOfZone ........................................................................................... 103UDNS_GetNSRecordsOfZone ........................................................................................... 104UDNS_GetPrimaryZonesOfUser ....................................................................................... 105UDNS_GetPTRRecordsOfZone ......................................................................................... 106UDNS_GetRecordsOfDnameByType ................................................................................ 107UDNS_GetRPRecordsOfZone ........................................................................................... 108UDNS_GetSecondaryZonesOfUser .................................................................................. 109UDNS_GetServerStatus ..................................................................................................... 110


27/154


24

UDNS_GetSOARecordOfZone .......................................................................................... 112UDNS_GetSSHFPRecordsOfZone .................................................................................... 113UDNS_GetTXTRecordsOfZone ......................................................................................... 115UDNS_GetUsers ................................................................................................................. 116UDNS_GetUserXInfo .......................................................................................................... 117UDNS_GetZoneInfo ............................................................................................................ 118UDNS_GetZonePrimarySources ....................................................................................... 119UDNS_NoAutoCommit....................................................................................................... 120UDNS_OpenConnection .................................................................................................... 121UDNS_QueryMailForwards ............................................................................................... 122UDNS_QueryWebForwards ............................................................................................... 123UDNS_RemoveRestrictIPForAllZones ............................................................................. 124

UDNS_RemoveRestrictIPForZone .................................................................................... 126UDNS_RequestZoneTransfer ............................................................................................ 127UDNS_UpdateAAAARecords ............................................................................................ 128UDNS_UpdateARecords .................................................................................................... 129UDNS_UpdateCNAMERecords ......................................................................................... 130UDNS_UpdateMailForward ................................................................................................ 131UDNS_UpdateNSRecords ................................................................................................. 132UDNS_UpdateWebForward ............................................................................................... 133UDNS_UpdateZonePrimarySources ................................................................................. 134


28/154


25

UDNS_AddMailForward

Syntax

UDNS_AddMailForward

emailTo

forwardTo

domain.

Description

This request adds a new email-forwarding request.

EmailTo is the redirected email address and must be a sub domain of domain.

ForwardTo is the redirected email address.

Domain is the fully-qualified domain of EmailTo.


29/154


26

UDNS_AddRestrictIPForAllZones

Syntax

UDNS_AddRestrictIPForAllZones

start_ip

end_ip

Description

This request adds the IP addresses of the servers allowed to perform an outgoing zone transfer ofall zones belonging to the user who opened the connection. The request only allows servers with

IP addresses it finds to transfer the zone data. If a zone already has a restriction, then the requestadds this restriction to its restriction list. Use this request carefully.

Since this request can affect many records, the server automatically commits the changes at regularintervals. This causes un-committed changes due to prior requests to be also committed to thedatabase. Therefore, Neustar recommends that when making this request do not group otherrequests in the transaction. This will decrease the possibility of undesired or partial changes beingcommitted to the database. The UDNS_NoAutoCommit has no effect on this behavior.

The start_ip and end_ip are the range of IP addresses.

If this request fails, the server responds with a message.


30/154


27

UDNS_AddRestrictIPForZone

Syntax

UDNS_AddRestrictIPForZone

Zone.

start_ip

end_ip

Description

This request adds the IP addresses of servers allowed to do an outgoing zone transfer of a givenzone. Only servers whose IP addresses appear in this list can perform a zone transfer. It is possibleto add multiple restrictions for a zone. This request does not allow duplicate restrictions for thesame zone.

Zone is the name of the zone to add the restriction.

The start_ip and end_ip are the range of IP addresses.



31/154


28

UDNS_AddUserXInfo

Syntax

UDNS_AddUserXInfo

Username

FieldName

Value

Description

This request sets the Value for extended information FieldName for the specified Username.



32/154


29

UDNS_AddWebForward

Syntax

UDNS_AddWebForward

requestTo

redirectTo

forwardType

domain.

Description

The requestTo parameter specifies the URL that needs redirecting. The http:// is required andthe page portion of the URL is optional. If page is not specified, then the value is defaulted to /.

RedirectTo is the URL destination of the redirect. You may use http:// and ftp:// and the pageportion of the URL is optional. URLs of the form http:// support port numbers. If the page is notspecified, then the value is defaulted to /.

The flag forwardType denotes the type of forward:

1 = framed

301 = HTTP 301 Redirect

302 = HTTP 302 Redirect.

Domain is the fully-qualified domain name (example.com.).


33/154


30

UDNS_ChangeAliasOfCNAMERecord

Syntax

UDNS_ChangeAliasOfCNAMERecord

Zone.

alias.

host.

NewAlias.

Description

This request changes the Alias portion of a CNAME record.

Zone is the name of the zone containing this CNAME record. It has to be a primary zone.

The alias and host parameters locate the CNAME record requiring the update.

The last parameter is the new alias value for the CNAME record. NewAlias replaces Alias in therecord.



34/154


31

UDNS_ChangeContentOfTXTRecord

Syntax

UDNS_ChangeContentOfTXTRecord

Zone.

Hostname.

OldContent

NewContent


35/154


32

UDNS_ChangeEmailOfSOARecord

Syntax

UDNS_ChangeEmailOfSOARecord

Zone.

[email protected]

Description

This request updates the email address of the SOA record for a zone.

If this request fails, the server responds with a

message.


36/154


33

UDNS_ChangeExpireLimitOfSOARecord

Syntax

UDNS_ChangeExpireLimitOfSOARecord

Zone.

86400

Description

This request updates the Expiry Limit field of a SOA record with a new value.

Zone

is the name of theprimary zone.The second parameter is the new value for the Expiry Limit.



37/154


34

UDNS_ChangeHostOfAAAARecord

Syntax

UDNS_ChangeHostOfAAAARecord

Zone.

Hostname.

IPAddress

NewHostname.

Description

This request changes the specified records hostname (Zone/Hostname/IPAddress) to NewHostname.The IPAddress supports either IPv6 compressed or uncompressed formats.



38/154


35

UDNS_ChangeHostOfARecord

Syntax

UDNS_ChangeHostOfARecord

Zone.

host.

1.1.1.1

NewHost.

Description

This request changes the host name portion of a Type A (Address) record.

Zone is the name of the zone containing this A record. It has to be a primary zone.

The host and ip_address parameters locate the A record to be updated.

NewHost is the new value for the host name portion of the A record.



39/154


36

UDNS_ChangeHostOfCNAMERecord

Syntax

UDNS_ChangeHostOfCNAMERecord

Zone.

alias.

host.

NewHost.

Description

This request changes the host name portion of a CNAME record.


The alias and host parameters locate the CNAME record to be updated.

The last parameter, NewHost, is the new value for the host name portion of the CNAME record.



40/154


37

UDNS_ChangeHostOfPTRRecord

Syntax

UDNS_ChangeHostOfPTRRecord

Zone.

1.1.1.1.in-addr.arpa.

host.

NewHost.

Description

This request changes the host name portion of a PTR record.

Zone is the name of the zone containing this PTR record. It has to be a primary zone.

The w.x.y.z.in-addr.arpa. and host parameters locate the PTR record for updating.

NewHost is the new value for the host name portion of the PTR record.



41/154


38

UDNS_ChangeHostOfTXTRecord

Syntax

UDNS_ChangeHostOfTXTRecord

Zone.

Hostname.

Content

NewHostname.

Description

This request replaces the existing Hostname in the TXT record for ZoneName/Hostname/Contentwith the New Hostname parameter.



42/154


39

UDNS_ChangeIPOfAAAARecord

Syntax

UDNS_ChangeIPOfAAAARecord

Zone.

Hostname.

IPAddress

New IP

Description

This request changes the specified records IP (Zone/Hostname/IPAddress) to NewIP. TheIPAddress supports either IPv6 compressed or uncompressed formats.



43/154


40

UDNS_ChangeIPOfARecord

Syntax

UDNS_ChangeIPOfARecord

Zone.

host.

1.1.1.1

1.1.2.2

Description

This request changes the IP address portion of an A (Address) record.



The last parameter is the new IP address for the A record. This value replaces the previous IPaddress of the record.



44/154


45/154


46/154


43

UDNS_ChangeMinimumCacheOfSOARecord

Syntax

UDNS_ChangeMinimumCacheOfSOARecord

Zone.

86400

Description

This request updates the Minimum Cache field of a SOA record with a new value.

Zone

is the name of the zone whose SOA record is to be updated. It has to be a primary zone.The second parameter is the new value for the Minimum Cache limit.



47/154


44

UDNS_ChangeNameServerOfNSRecord

Syntax

UDNS_ChangeNameServerOfNSRecord

Zone.

ServedDomain.

NameServer.

NewNameServer.

Description

This request changes the name server portion of a NS record. It can be used to change the nameserver that serves a zone.

Zone is the name of the zone containing this NS record. It has to be a primary zone.

ServedZone and NameServer parameters locate the NS record to be updated.

NewNameServer is the host name of the new name server of the ServedZone. It replaces the valueNameServer so that NewNameServer now services ServedZone.



48/154


45

UDNS_ChangeNameServerOfSOARecord

Syntax

UDNS_ChangeNameServerOfSOARecord

Zone.

NewNameServer.

Description

This request updates the name server of a zones SOA record.

Zone

is the name of the SOA records zone.NameServer is the host name of the new name server of the Zone.



49/154


50/154


47

UDNS_ChangeRefreshIntervalOfSOARecord

Syntax

UDNS_ChangeRefreshIntervalOfSOARecord

Zone.

86400

Description

This request updates the Refresh Interval field of a SOA record with a new value.

Zone

is the name of the zone whose SOA record is to be updated. It has to be a primary zone.The second parameter is the new value for the Refresh Interval.



51/154


48

UDNS_ChangeRetryIntervalOfSOARecord

Syntax

UDNS_ChangeRetryIntervalOfSOARecord

Zone.

86400

Description

This request updates the Retry Interval field of a SOA record with a new value.

Zone

is the name of the zone whose SOA record is to be updated. It has to be a primary zone.The second parameter is the new value for the Retry Interval.



52/154


49

UDNS_ChangeSerialNumberOfSOARecord

Syntax

UDNS_ChangeSerialNumberOfSOARecord

Zone.

Serial Number

Description

This request changes the Serial number of an SOA record.

Zone

is the name of the zone containing this SOA record. It has to be a primary zone.Serial Number is an optional parameter. If specified, the parameter sets the SOA records serialnumber. If not specified, the request increments the existing serial number.



53/154


50

UDNS_ChangeServedDomainOfNSRecord

Syntax

UDNS_ChangeServedDomainOfNSRecord

Zone.

ServedDomain.

NameServer.

NewDomain.

Description

This request changes the domain name portion of a NS record.


ServedZone and NameServer parameters locate the NS record to be updated.

NewDomain is the name of the new domain that NameServer is supposed to serve. NewDomain has tobe a sub-domain of Zone.



54/154


51

UDNS_ChangeServedZoneOfMXRecord

Syntax

UDNS_ChangeServedZoneOfMXRecord

Zone.

ServedZone.

MailServer.

NewZone.

Description

This request changes the zone that a mail server services. It changes the ServedZone field of a MXrecord.

Zone is the name of the zone containing this MX record. It has to be a primary zone.

The ServedZone and MailServer parameters locate the MX record this request will update.

The last parameter is the name of the new zone that MailServer is supposed to serve.



55/154


52

UDNS_ChangeTTLOfAAAARecord

Syntax

UDNS_ChangeTTLOfAAAARecord

Zone.

Hostname.

IPAddress

NewTTL

Description

This request changes the specified records TTL (Zone/Hostname/IPAddress) to NewTTL. TheIPAddress supports either IPv6 compressed or uncompressed formats.

Zone is the name of the zone containing this AAAA record. It has to be a primary zone.

The Hostname and ip_address parameters locate the AAAA record this request will update.

The last parameter is the NewTTL value (for example, 86400).



56/154


53

UDNS_ChangeTTLOfARecord

Syntax

UDNS_ChangeTTLOfARecord

Zone.

host.

1.1.1.1

NewTTL

Description

This request changes the TTL of a Type A (Address) record.






57/154


54

UDNS_ChangeTTLOfCNAMERecord

Syntax

UDNS_ChangeTTLOfCNAMERecord

Zone.

alias.

host.

NewTTL

Description

This request changes the TTL of a CNAME record.


The alias and host parameters locate the CNAME record to the request will update.




58/154


55

UDNS_ChangeTTLOfMXRecord

Syntax

UDNS_ChangeTTLOfMXRecord

Zone.

ServedZone.

MailServer.

NewTTL

Description

This request changes the TTL of a MX record.

Zone is the name of the zone containing this MX record. It has to be a primary zone.

The ServedZone and MailServer parameters locate the MX record the request will update.




59/154


56

UDNS_ChangeTTLOfNSRecord

Syntax

UDNS_ChangeTTLOfNSRecord

Zone.

ServedDomain.

NameServer.

NewTTL

Description

This request changes the TTL of a NS record.


ServedZone and NameServer parameters locate the NS record requiring updates.




60/154


61/154


58

UDNS_ChangeTTLOfSOARecord

Syntax

UDNS_ChangeTTLOfSOARecord

Zone.

NewTTL

Description

This request updates the TTL field of a SOA record with a new value.

Zone

is the name of the zone whose SOA record the request will update. It has to be a primaryzone.




62/154


59

UDNS_ChangeTTLOfTXTRecord

Syntax

UDNS_ChangeTTLOfTXTRecord

Zone.

Hostname.

Content

NewTTL

Description

This request replaces the existing TTL in the TXT record for ZoneName/Hostname/Content with thevalue passed in the NewTTL parameter.

Zone is the name of the zone containing the TXT record. It has to be a primary zone.

The zone, hostname, and Content parameters locate the TXT record the request will update.




63/154


60

UDNS_ChangeUserEmail

Syntax

UDNS_ChangeUserEmail

UserName

NewEmail

Description

This request allows the user to change the email address of their account or other user accountswithin the same sponsor. The request to change the email address in other user accounts will

succeed only if the requestor has rights to do this. This request does not change the email in anySOA records owned by the user.

The UserName is an ID of the user whose email address has to be changed. It can be a maximum of32 characters.

The request passes the user's new email as a string in the NewEmail parameter. The maximumlength of the email address is 100 characters.



64/154


61

UDNS_ChangeUserPassword

Syntax

UDNS_ChangeUserPassword

UserName

OldPassword

NewPassword

Description

This request allows the user to change their account password or other user account passwordswithin the same sponsor. The request to change the password of other user accounts will succeedonly if the requestor has rights to do this.

The UserName is an ID of the user whose password has to be changed. It can be a maximum of 32characters.

The OldPassword is the current password of the user account. It also has a maximum length of 32characters.

The NewPassword is the new password of the user account. It also has a maximum length of 32characters.



65/154


62

UDNS_CloseConnection

Syntax

UDNS_CloseConnection

Description

The UDNS_CloseConnection request closes the connection to the server. Call this request after thecaller has finished all transactions. Further transactions will not be possible untilUDNS_OpenConnectioncreates a new login. This request does not disconnect the socketuseUDNS_Disconnect to close the socket.


66/154


63

UDNS_CreateAAAARecord

Syntax

UDNS_CreateAAAARecord

Zone.

Hostname.

IPAddress

Description

This request creates an AAAA record in the specified Zone with the hostname of Hostname and theIP address of IPAddress. IPAddress supports either IPv6 compressed or uncompressed formats.



67/154


64

UDNS_CreateARecord

Syntax

UDNS_CreateARecord

ZoneName.

HostName.

ipAddr

Description

This request creates a Type A resource record for a given hostname in a given primary zone. Thisrecord will be created in this zone only if the user making the request is also the owner of the zone.If the A record is created successfully then the owner of the zone will also be made owner of the Arecord.

The ZoneName is the name of the zone where this A record is to be created. This zone must be aprimary zone.

HostName is the name of the host within ZoneName. This must be a fully qualified name.

ipAddr is the IP address of HostName in string format.



68/154


65

UDNS_CreateCNAMERecord

Syntax

UDNS_CreateCNAMERecord

ZoneName.

Alias.

HostName.

Description

This request creates a CNAME record for a given host in a given primary zone. This record will becreated in this zone only if the user making the request is also the owner of the zone. If theCNAME record is created successfully then the owner of the zone will also be made owner of theCNAME record.

The ZoneName is the name of the zone where this CNAME record is to be created. This zone mustbe a primary zone.

Alias is the canonical name of the host.

HostName is the name of a host within ZoneName for which this record should be created.

Duplicate CNAME records (that is, CNAME records with the same ZoneName,Alias andHostName) cannot be created.



69/154


66

UDNS_CreateMXRecord

Syntax

UDNS_CreateMXRecord

ZoneName.

ServedZone.

MailServer.

priority

Description

This request creates a MX record for a given mail server in a given primary zone. This record willbe created in this zone only if the user making the request is also the owner of the zone. If the MXrecord is created successfully then the owner of the zone will also be made owner of the MXrecord.

The ZoneName is the name of the zone where this MX record is to be created. This zone must be aprimary zone.

The ServedZone is the name of the zone that this MailServer will service.

MailServer is the name of the mail server.

Priority is unsigned 16-bit number that represents the preference value of this mail server.



70/154


67

UDNS_CreateNSRecord

Syntax

UDNS_CreateNSRecord

ZoneName.

SubDomain.

NameServer.

Description

This request creates a NS record for a given primary zone. This record will be created in this zoneonly if the user making the request is also the owner of the zone. If the NS record is createdsuccessfully then the owner of the zone will also be made owner of the NS record.

The ZoneName is the name of the zone where this NS record is to be created. The zone must be aprimary zone.

The SubDomain is the name of the zone for which this NameServer is responsible. The values ofZoneName and SubDomain can be the same in case you want to add more name servers forZoneName.

NameServer is the name of the Name Server for SubDomain.



71/154


68

UDNS_CreatePrimaryZone

Syntax

UDNS_CreatePrimaryZone

ZoneName.

forceImport

Description

This request creates a primary zone and its supporting (SOA, NS and A) records in the NeustarUltra Services database. The supporting records are created such that Neustar Ultra Services

Name servers act as the primary servers for this zone. The user who authenticated to the APIserver becomes the owner of this zone.

The ZoneName is the name of the new zone. This must be a fully qualified name.

The forceImport argument is optional and useful if the new zone was a child zone (apromotedzone). If present and set to True, forceImport moves any associated records with the newlypromoted zone. For example, if the new zone is promoted.example.com , forceImport movesrecords like ftp.promoted.example.com and hostname.promoted.example.com to thenew zone.



72/154


73/154


70

UDNS_CreateResourceRecord

Syntax

UDNS_CreateResourceRecord

0303372E01CBF764

www.example.biz.

1

1025

300

982a1479b1273891273c81279831d

Description

This request creates resource records for unknown resource record types as defined inRFC 3597.

This request does not create resource records that have established methods (for example,UDNS_CreateCNAMERecord). This method returns the GUID for the record created and uses thefollowing values:

o id is the ID of the zone (obtained fromUDNS_GetZoneInfo on page118).

o hostname is the domain name of the record (with the trailing dot)

o Class is the DNS class of the record, which is usually 1 (IN).

o Type: is the DNS type of the record (in our example, 1025)

o TTL: The TTL for the record (in our example, 300 seconds).

o Data: The data for the record. This is binary data formatted as a hexstring. Each byte is

made up of two characters, 0-9a-f. For example: 01ab6c.

Response

0403372E01CBF99F
http://www.ietf.org/rfc/rfc3597.txthttp://www.ietf.org/rfc/rfc3597.txthttp://www.ietf.org/rfc/rfc3597.txthttp://www.ietf.org/rfc/rfc3597.txt


74/154


71

UDNS_CreateRPRecord

Syntax

UDNS_CreateRPRecord

Zone.

Host.

[email protected]

data.

Description

This request creates an RP record for the given Zone, Host, and email. The data is the TXT towhich this record points. The TXT record must exist before calling UDNS_CreateRPRecord.



75/154


72

UDNS_CreateSecondaryZone

Syntax

UDNS_CreateSecondaryZone

ZoneName.

PrimaryNameServer1

PrimaryNameServer2

PrimaryNameServer3

Description

This request creates a secondary zone record in the Neustar Ultra Services database. This requestis used when a primary name server already serves the zone and Neustar Ultra Services nameservers are only to act as secondary name servers for the zone. The owner of this zone will be set tothe user who authenticated to the API server.

The ZoneName must be a fully qualified name.

PrimaryNameServer is the IP address of the primary (authoritative) name server of the zone. Youmay optionally specify up to three name servers.



76/154


73

UDNS_CreateSSHFPRecord

Syntax

UDNS_CreateSSHFPRecord

test.zone.

sshfp2.test.zonel.

0

1

0123456789abcdef

Description

This request creates an SSHFP record from the specified zone. The first parameter is the zone; thesecond parameter is the host name of the record; third parameter is the algorithm (valid values: 0,1, and 2); fourth parameter is the fingerprint type (valid values: 0 and 1); the fifth parameter is thefingerprint as a hexint.


Response

Method succeeded


77/154


74

UDNS_CreateTXTRecord

Syntax

UDNS_CreateTXTRecord

Zone.

Hostname.

Content

Description

This request creates a TXT record for the given Zone and Hostname. The Content is the desiredrecord content.



78/154


75

UDNS_CreateUser

Syntax

UDNS_CreateUser

NewUserName

Password

Email

FirstInitial

LastInitial

ServicePkg

PricingPkg

Description

This request creates a new user account in the Neustar Ultra Services database. A user account has

two records: a user record and a contact record. This request in effect, creates both of these records.The request creates the new user account only if the user who authenticated to the API server hasrights to create other user accounts.

The NewUserName is an ID selected by the user. This is the ID the user will use to authenticate to theNeustar Ultra Services API server or Management Utility. It can be a maximum of 32 characters.

The Password is also a 32-character string selected by the user. This, in conjunction with theusername, can authenticate the user to the Neustar Ultra Services API server and Managementutility.

The request passes the user's email as a string in the Email parameter. The maximum length of the

email address is 100 characters.

FirstInitial and LastInitial are the user's first and last name initials, respectively, in uppercase.

ServicePkg and PricingPkg denote the type of service and pricing for which the user hassubscribed. Neustar provides these packages out-of-band to the user.



79/154


80/154


77

UDNS_DeleteAllRecordsOfUser

Syntax

UDNS_DeleteAllRecordsOfUser

UserName

Description

This request deletes not only the user and contact records but also all RR and zone records ownedby this user. Use this request carefully. This request removes zone(s) and Resource Records fromthe Neustar Ultra Services servers. The request deletes the user account only if the user whoauthenticated to the API server has rights to delete other user accounts. This request cannot deletethe user and contact records of the requestor.

Since this request can affect many records, the server automatically commits the changes at regularintervals. This causes un-committed changes due to prior requests to be also committed to thedatabase. Therefore, it recommended that when making this request, no other requests be groupedin that transaction. This will decrease the possibility of undesired or partial changes beingcommitted to the database. UDNS_NoAutoCommit has no effect on this behavior.

The UserName is the ID of the user whose records are to be deleted. It can be a maximum of 32characters.



81/154


78

UDNS_DeleteARecord

Syntax

UDNS_DeleteARecord

ZoneName.

HostName.

ipAddr

Description

This request deletes the A record with HostName and ipAddr from the primary zone ZoneName.This record will be deleted only if the user making the request is the owner of the A record.

The ZoneName is the name of the zone from where this A record is to be deleted. This zone must bea primary zone.

HostName is the name of the host in the A record.

ipAddr is the IP address of the host in string format.

This request deletes all duplicate A records.


message.


82/154


79

UDNS_DeleteCNAMERecord

Syntax

UDNS_DeleteCNAMERecord

ZoneName.

Alias.

Description

This request deletes the CNAME record containing Alias from a given zone. This record will bedeleted only if the user making the request is the owner of the record.

The ZoneName is the name of the zone where this CNAME record is to be created. This zone mustbe a primary zone.

Alias is the canonical name of the host.



83/154


80

UDNS_DeleteMailForward

Syntax

UDNS_DeleteMailForward

guid

domain.

Description

Guid is the global unique identifier for the mail record to delete.

Domain is the fully-qualified domain name (example.com.).


84/154


81

UDNS_DeleteMXRecord

Syntax

UDNS_DeleteMXRecord

ZoneName.

ServedZone.

MailServer.

Description

This request deletes the MX record for a given mail server in a given zone. This record will bedeleted only if the user making the request is the owner of the MX record.

The ZoneName is the name of the zone from where this MX record is to be created. This must be afully qualified name. This zone must be a primary zone.

The ServedZone is the name of the zone that this MailServer services.

MailServer is the name of the mail server. This must be a fully qualified name.

This request deletes all duplicate MX records.


message.


85/154


82

UDNS_DeleteNSRecord

Syntax

UDNS_DeleteNSRecord

ZoneName.

SubDomain.

NameServer.

Description

This request deletes the NS record of NameServer from the primary zone ZoneName only if the usermaking the request is the owner of the NS record.

The ZoneName is the name of the zone from where this NS record is to be deleted. This zone mustbe a primary zone.

SubDomain and NameServer are the 2 parts of the NS record.

This request deletes all duplicate NS records.



86/154


83

UDNS_DeletePTRRecord

Syntax

UDNS_DeletePTRRecord

ZoneName.

4.3.2.1.in-addr.arpa.

HostName.

Description

This request deletes the PTR record with IP address ipAddr and hostname HostName from thegiven primary zone. This record will be deleted only if the user making the request is the owner ofthe A record.

The ZoneName is the name of the zone where this record is to be created. This zone must be aprimary zone.

ipAddr is the reversed IP address of HostName. Therefore, if the IP address of HostName is 1.2.3.4then the ipAddr should be 4.3.2.1.in-addr.arpa. .

HostName is the name of the host in this record.

This request deletes all duplicate PTR records.



87/154


84

UDNS_DeleteResourceRecord

Syntax

UDNS_DeleteResourceRecord

0303372E01CBF764

0403372E01CBF99F

Description

This request deletes resource records, including records that may already have establishedmethods for deletion (for example UDNS_DeleteCNAMERecord). This request passes two IDs:Zoneid and RRid.

Zoneid is the ID of the zone using the UDNS_GetZoneInfomethod on page118.

RRid is the ID of the Resource Record you want to delete. Use eitherUDNS_FindResourceRecordson page95orUDNS_CreateResourceRecord on page 70to obtain this value.

This method returns a successful response if request was successful. If this request fails, the serverresponds with a message.


88/154


85

UDNS_DeleteRPRecord

Syntax

UDNS_DeleteRPRecord

Zone.

Host.

email

Description

This request deletes an RP record for the given Zone, Host, and email.



89/154


86

UDNS_DeleteSSHFPRecord

Syntax

UDNS_DeleteSSHFPRecord

test.zone.

sshfp.test.zone.

Description

This request deletes an SSHFP record from a zone. First parameter is the zone, and the secondparameter is the hostname of the record to delete.


Response

Method succeeded


90/154


87

UDNS_DeleteTXTRecord

Syntax

UDNS_DeleteTXTRecord

Zone.

Hostname.

Description

This request deletes a TXT record for the given Zone and Hostname.


message.


91/154


88

UDNS_DeleteUser

Syntax

UDNS_DeleteUser

UserName

Description

This request deletes both the user and a contact record from the Neustar Ultra Services database.Make this request only after deleting all other records owned by this user. The request deletes theuser account only if the user who authenticated to the API server has rights to delete other useraccounts. This request cannot delete the user and contact records of the requestor.

The UserName is the ID of the user to delete. It can be a maximum of 32 characters.



92/154


89

UDNS_DeleteUserXInfo

Syntax

UDNS_DeleteUserXInfo

Username

FieldName

Description

This request deletes the extended information for the specified FieldName for the specifiedUsername.



93/154


94/154


91

UDNS_DeleteZone

Syntax

UDNS_DeleteZone

ZoneName.

Description

This request deletes a zone and all its resource records from the Neustar Ultra Services database.The request will succeed only if user making this request is the owner of the zone.

Since this request can affect many records, the server automatically commits the changes at regularintervals. This causes un-committed changes due to prior requests to be also committed to the

database. Therefore, it recommended that when making this request, no other requests be groupedin that transaction. This will decrease the possibility of undesired or partial changes beingcommitted to the database. UDNS_NoAutoCommit has no effect on this behavior.

The ZoneName is the name of the zone to be deleted. This must be a fully qualified name.



95/154


92

UDNS_DisableAutoSerialUpdate

Syntax

UDNS_DisableAutoSerialUpdate

Description

This request disables auto serial updating for the life of the existing session. It takes no parameters.



96/154


93

UDNS_Disconnect

Syntax

UDNS_Disconnect

Description

This request schedules a disconnection of the socket after the end of the transaction. Thetransaction follows normal rules of commit or rollback.



97/154


94

UDNS_EnableAutoSerialUpdate

Syntax

UDNS_EnableAutoSerialUpdate

Description

This request sets auto serial updating for the life of the existing session. It takes no parameters.



98/154


95

UDNS_FindResourceRecords

Syntax

UDNS_FindResourceRecords

0123456789ABCDEF

hostname.myzone.com.

1

Description

This method returns a list of resource records based on the search criteria. The first parameter is

the id of the zone returned from UDNS_GetZoneInfo(page 118).

Zone ID (the first parameter) and Resource Record type (the second parameter) are required. Thenext fields are optional, and are the search data. This data is in the form of strings, and is the datain each of the record fields. You must match the string exactly. For example, if you were lookingfor an A record with an IP address of 1.2.3.4, you must send:

0123456789ABCDEF

1

1.2.3.4

Response

The response is similar to UDNS_GetAllRRsOfZoneon page 97, but with an addition of for

each record.


99/154


96

UDNS_GetAAAARecordsOfZone

Syntax

UDNS_GetAAAARecordsOfZone

Zone.

Description

This request returns the AAAA records for the specified Zone. If this request fails, the serverresponds with a message.

Example Response

hostname

a.testzoneprimary.myzone.

address

1234:0:0:0:0:0:0:1234

ttl

86400


100/154


97

UDNS_GetAllRRsOfZone

Syntax

UDNS_GetAllRRsOfZone

Zone.

Description

This request retrieves all resource records of a given zone. The server will respond with a XMLarray of the different resource records.

Zone is the name of the zone from which the request will retrieve the resource records.

Example Response

hostname

host1.

address

1.1.1.1

ttl

86400

servedzone

zone1.


101/154


98

nameserver

ns.zone1.

ttl

86400

The returned resource records depend on the zone. They can be any combination of ;; ; ; ; , and others.



102/154


99

UDNS_GetAllZonesOfUser

Syntax

UDNS_GetAllZonesOfUser

UserName

Description

This request returns a list of all (both primary and secondary) zones that belong to a given user. Itcan be used to query for zones owned by the requestor or zones owned by some other user. Therequest for zones owned by some other user will succeed only if the requestor has rights to do this.The list of zones returned forms an XML array.

UserName is the name of the user whose zones the request will retrieve.

Response Example

zone1.

zone2.

zone3.

...



103/154


100

UDNS_GetARecordsOfZone

Syntax

UDNS_GetARecordsOfZone

Zone.

Description

This request retrieves the type A records of a given zone. The server will respond with an XMLarray of s (as described earlier in the XML RPC extensions section).

Zone is the name of the zone from which the A records are to be retrieved.

Response Example

...

...

...



104/154


105/154


102

UDNS_GetCNAMERecordsOfZone

Syntax

UDNS_GetCNAMERecordsOfZone

Zone.

Description

This request retrieves all CNAME records of a given zone. The server responds with a XML arrayof s (as described in theXML-RPC Extensionssection on page 8).

Zone is the name of the zone from which the request retrieves the CNAME records.

Example Response

...

...

...



106/154


103

UDNS_GetMXRecordsOfZone

Syntax

UDNS_GetMXRecordsOfZone

Zone.

Description

This request retrieves the MX records of a given zone. The server will respond with a XML arrayof s (as described earlier in the XML RPC extensions section).

Zone is the name of the zone from which the request will retrieve the MX records.

Example Response

...

...

...



107/154


104

UDNS_GetNSRecordsOfZone

Syntax

UDNS_GetNSRecordsOfZone

Zone.

Description

This request retrieves the NS records of a given zone. The server will respond with a XML array ofs (as described earlier in the XML RPC extensions section).

Zone is the name of the zone from which the NS records are to be retrieved.

Response Example

...

...

...



108/154


105

UDNS_GetPrimaryZonesOfUser

Syntax

UDNS_GetPrimaryZonesOfUser

UserName

Description

This request returns a list of all primary zones that belong to a given user. It can query for primaryzones owned by the requestor or primary zones owned by some other user. The request for zonesowned by some other user will succeed only if the requestor has rights to do this. The requestreturns the list of zones in the form of a XML array.


Example Response

zone1.

zone2.

zone3.

...



109/154


106

UDNS_GetPTRRecordsOfZone

Syntax

UDNS_GetPTRRecordsOfZone

Zone.

Description

This request retrieves all PTR records of a given zone. The server will respond with a XML arrayof s (as described earlier in the XML RPC extensions section).

Zone is the name of the zone from which the PTR records are to be retrieved.

Example Response

...

...

...



110/154


107

UDNS_GetRecordsOfDnameByType

Syntax

UDNS_GetRecordsOfDnameByType

Zone.

Hostname.

Type

Description

This request returns a list of records for the specified Zone, Hostname, and Type. The Typeparameter is the int code value for a record (for example, 1 for A and 2 for NS records).

Example Response (for A records)

...

...

...



111/154


108

UDNS_GetRPRecordsOfZone

Syntax

UDNS_GetRPRecordsOfZone

Zone.

Description

This request returns all RP records for a particular zone

Example Response

...

...

...



112/154


109

UDNS_GetSecondaryZonesOfUser

Syntax

UDNS_GetSecondaryZonesOfUser

UserName

Description

This request returns a list of all secondary zones that belong to a given user. It can query forsecondary zones owned by the requestor or secondary zones owned by some other user. Therequest for zones owned by some other user will succeed only if the requestor has rights to do this.The request returns the list of zones in an XML array.


Example Response

zone1.

zone2.

zone3.

...



113/154


110

UDNS_GetServerStatus

Syntax

UDNS_GetServerStatus

Description

This request returns the status of Neustar server nodes. It takes no parameters.

Response

node

Ashburn, VA

status

Up

node

Australia

status

Up

node

London

statusUp

Response continues on next page.


114/154


115/154


112

UDNS_GetSOARecordOfZone

Syntax

UDNS_GetSOARecordOfZone

Zone.

Description

This request retrieves the SOA record of a given zone. The server will respond with a record (as described earlier in the XML RPC extensions section) containing the SOArecord information. Since there is only one SOA record in a zone, the response will contain onlyone record.

Zone is the name of the zone from which the SOA record the request will retrieve.

Example Response

...



116/154


117/154


114

algo

0

fptype

1

fp

0123456789abcdef

ttl

86400



118/154


115

UDNS_GetTXTRecordsOfZone

Syntax

UDNS_GetTXTRecordsOfZone

Zone.

Description

This request returns all TXT records for a particular zone.

Example Response

...

...

...



119/154


116

UDNS_GetUsers

Syntax

UDNS_GetUsers

Description

This request returns the list of all users that belong to the SponsorID provided by theUDNS_OpenConnection. It requires no parameters. The request returns the list in the form of aXML array of usernames. The request will succeed only if the requestor has rights to read otherusers' account information.

Example Response

user1

user2

user3

...


message.


120/154


117

UDNS_GetUserXInfo

Syntax

UDNS_GetUserXInfo

Username

FieldName

Description

This request returns the value for the extended information FieldName for the specified Username.

Example Response

testdata



121/154


118

UDNS_GetZoneInfo

Syntax

UDNS_GetZoneInfo

test.zone.

Description

This method returns information about a zone, including its ID.

Response

id

test.zone.

id

0123456789ABCDEF


122/154


119

UDNS_GetZonePrimarySources

Syntax

UDNS_GetZonePrimarySources

test.zone.

Description

Returns on array of IP address for the specified zone. Use this method call before using theUDNS_UpdateZonePrimarySourcesmethod call on page 134.


123/154


120

UDNS_NoAutoCommit

Syntax

UDNS_NoAutoCommit

Description

This request allows the client to disable the auto-committing feature of the server. A single can group only a limited number of s. If the number of exceeds this limit, then all un-committed changes are automatically and silently committed to thedatabase. If the client wishes to turn this feature off then it can send the UDNS_NoAutoCommit at anytime after opening a connection. The server will, from that point onwards, continue to check thelimit but will not auto-commit the changes. Instead it will send the client a responsewith a informing it that the limit has been crossed. The server then rolls back all the un-committed changes. The server will commit changes only if it has processed the entire transactionwithout crossing the limit.

The server will behave in this fashion as long as this connection is open. It will behave this wayonly for this connection; other connections are not affected.

This request does not require any parameters.



124