Your IP address could not be determined at this time.

Reg-RWS Quick Start Guide

Overview

    ARIN Online users can use Reg-RWS to retrieve and modify records within ARIN's database by sending URLs and xml payloads in an automatable, computer-friendly manner using modern application interfaces that provide strong authentication. You can use Reg-RWS to do perform these and other actions:

  • Retrieve and modify information about delegations and networks
  • Reassign and reallocate network space
  • Retrieve and modify information about Orgs, POCs, and customers
  • Get information about tickets (requests for ARIN to perform an action) and add messages to tickets
  • Submit Route Origin Authorizations (ROAs)
  • Request reports
  • Before You Begin

    You'll need the following before using Reg-RWS:

  • Understanding of ARIN's database structure
  • ARIN Online account.
  • API Key
  • Point of Contact in ARIN Online

Note: Your POC must have the authority to manage records for an Org. (For example, you must be linked to an Admin or Tech POC for the Org whose records you are managing.) ARIN's Reg-RWS won't process any modifications to a database record unless you have an ARIN Online account linked to a POC with proper authority over that record.

Reg-RWS Components

URLs

In its simplest form, a Reg-RWS action can be a URL that is entered in a browser. In this case, The URL that is used when interacting with ARIN through Reg-RWS will specify three key things:

  • The address of the database being interacted with: For Reg-RWS, the address is https://reg.arin.net.
  • The database object being interacted with (for example, poc). In addition, when performing some actions such as retrieving or deleting an object, the object name name or handle must be included in the URL.
  • The API Key associated with the user's ARIN Online account. Note that the "apikey=" variable name in the URL must be lowercase, and the actual API Key must be uppercase.

For example, to retrieve information about a specific POC, you could enter the following URL into a browser address window:

https://reg.arin.net/rest/poc/POCHANDLE?apikey=APIKEY

where the following information is included:

  • Address: reg.arin.net
  • Database object: poc
  • Object name: the name of the POC handle for which you want to view information
  • API Key: your API key in ARIN Online.

A full example of this command would be:

https://reg.arin.net/rest/poc/KOSTE-ARIN?apikey=4935-C028-BE11-817F

Methods and Payloads

Most uses of Reg-RWS involve coding software or scripts to perform multiple transactions at one time with the ARIN database. When using Reg-RWS this way, there are multiple components to a Reg-RWS action:

  • method
  • URL (see previous description)
  • payload (only required when using some methods)

A method is a type of interaction with ARIN's database records, or “call,” within Reg-RWS. When sending URLs through Reg-RWS, users must also specify the method of interaction their specific call uses. Methods include the following:

  • GET retrieves information about a record
  • POST creates a new record
  • PUT modifies an existing record  
  • DELETE deletes a record

When using methods that alter database records without deleting them (PUT and POST), Reg-RWS will require more information than the URL provides. For example, if you wish to create or change contact information for a POC or ORG, Reg-RWS will require you to provide that information in a computer-friendly manner. To accomplish this, you must send formatted xml layouts known as payloads. These payloads contain details about the record being created or modified, including organization information, POC information, IP address ranges, customer data, etc. To ensure that your payload is current, perform a GET before performing a PUT or POST with a given record. 

ARIN provides methods and payloads pages for Reg-RWS users. The Methods Page describes each database interaction, the appropriate method and URL structure, and which payloads will be sent and returned. The Payloads Page details each payload structure, provides examples of completed payloads and explains common error codes returned by Reg-RWS when it receives information it cannot understand or process correctly.

Reg-RWS Examples

Getting Information About a POC

You want to get information about a POC. The following table shows the method, URL, other information. Because you are only retrieving information about a POC, there is no content (payload). The Returns field specifies the payload that you will see returned from Reg-RWS upon sending a correct URL using the correct method.

Definition
Method GET
URL /rest/poc/POCHANDLE?apikey=APIKEY
Content NONE
Returns PocPayload

Returns the details of a POC record.

If no POC can be found with the handle specified, an exception containing an ErrorPayload will be thrown.

Return Payload Example:

Performing a Reassignment to a New Customer

Step One: Creating a Recipient Customer

You want to create a customer who will be receiving a simple reassignment from you. This call will create a Org using the details in the Customer Payload you provide, and the handle in your URL specifying the parent NET from which this Org will be receiving a simple reassignment. This call will then return a payload containing information about this newly-created Customer. Customers automatically inherit the POCs of their parent Org.

Note: Be sure your API Key is linked to a POC that is either the Admin or Tech POC for the Org holding the parent NET, or the Tech POC for the NET itself. Otherwise you will receive an error.

 

Definition
Method POST
URL

/rest/net/PARENTNETHANDLE/customer?apikey=APIKEY

Content

Customer Payload:

<customer xmlns="http://reg.arin.net/rest" >
<customerName>CUSTOMERNAME</customerName>
<iso3166-1>

<name>UNITED STATES</name>
<code2>US</code2>
<code3>USA</code3>
<e164>1</e164>

</iso3166-1>
<handle></handle>
<streetAddress>

<line number = "1">Line 1</line>

</streetAddress>
<city>Chantilly</city>
<iso3166-2>VA</iso3166-2>
<postalCode>20151</postalCode>
<comment>

<line number = "1">Line 1</line>

</comment>
<parentOrgHandle>PARENTORGHANDLE</parentOrgHandle>
<registrationDate>Mon Nov 07 14:04:28 EST 2011</registrationDate> <privateCustomer>false</privateCustomer>

</customer>

Returns Customer payload

Content Payload Example:

Return Payload Example:

Step Two: Reassign Space to the Newly-Created Customer

You want to perform a simple reassignment to the customer you created in Step One. This call performs a reassignment from the NET specified in your URL using the recipient information contained in the NET Payload you provide. Reassignments are given to an Org or Customer for their own use and may not be reallocated or reassigned further. To perform a simple reassignment, specify a Customer in the NET Payload you send.

 

Definition
Method PUT
URL

/rest/net/PARENTNETHANDLE/customer?apikey=APIKEY

Content

NET Payload:

<net xmlns="http://www.arin.net/regrws/core/v1" >
<version>4</version>
<comment>
<line number = "1">Line 1</line>
</comment>
<registrationDate></registrationDate>
<orgHandle></orgHandle>
<handle></handle>
<netBlocks>
<netBlock>
<type>S</type>
<description>DESCRIPTION</description>
<startAddress>24.139.0.0</startAddress>
<endAddress></endAddress>
<cidrLength>24</cidrLength>
</netBlock>
</netBlocks>
<customerHandle>C06701689</customerHandle>
<parentNetHandle>NET-24-139-0-0-1</parentNetHandle>
<netName>netname</netName>
</net>

Returns Customer payload

Content Payload Example:

Return Payload Example:

Common Reg-RWS Tasks

Some of the common Reg-RWS tasks you might want to perform are listed below. Click the links to see syntax information for each task.

Search Related Content

Loading

full site search

Registration Services Help Desk

Interacting With ARIN

Monday through Friday
7:00 AM to 7:00 PM ET
Phone: +1.703.227.0660
Fax: +1.703.997.8844
Email: hostmaster@arin.net
Tips for Calling the Help Desk