Automating Record Management with Reg-RWS on American Registry for Internet Numbers

Reg-RWS Quick Start Guide

Tue, 04 Sep 2018 09:35:58 -0400

Overview

ARIN Online users can also use Reg-RWS in addition to the graphical user interface to retrieve and modify records within ARIN’s database by sending URLs and XML or Routing Policy Specification Language (RPSL) payloads in an automatable, computer-friendly manner using modern application interfaces that provide strong authentication. You can use Reg-RWS to perform these and other actions:

Retrieve and modify information about delegations and networks
Reassign and reallocate network space
Retrieve and modify information about Orgs, Points of Contact (POCs), and customers
Get information about tickets (requests for ARIN to perform an action) and add messages to tickets
Submit Route Origin Authorizations (ROAs)
Retrieve and edit Internet Routing Registry (IRR) objects
Request reports, such as WhoWas (historical registration information) or reassignments for a given network

For more information about Reg-RWS and frequently asked questions, visit Automating Record Management with Reg-RWS.

RESTful Methods

Tue, 04 Sep 2018 09:35:58 -0400

Introduction

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

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

Each of the following entries describes a database interaction, the appropriate method to use, the proper URL structure, and which payloads will be sent and/or returned to the user.

RESTful Payloads

Tue, 04 Sep 2018 09:35:58 -0400

Introduction

When using RESTful methods that alter database records without deleting them (for example, PUT and POST), Reg-RWS will require more information in the form of properly formatted Extensible Markup Language (XML) layouts, called payloads. These payloads contain details about the record being created or modified, including organization information, POC information, IP address ranges, customer data, etc. Each entry below explains a particular XML payload and provides an example of said payload completed using sample information. Each entry also shows which fields may not be modified or are generated by Reg-RWS automatically. (XML payloads for Internet Routing Registry (IRR) commands are described in the ARIN IRR RESTful API User Guide.)