RESTful Payloads

Skip to main text Jump to related content

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.)

Note: In general, when given multiple ways to express the same information, only one way is required. For example, network range and CIDR prefixes describe the same block of IP addresses, and one can be derived from the other.

Allowable Characters in Payloads

XML payloads support ASCII encoding only; however, comment fields which support free-form text (e.g., in ORG, NET, and POC payloads) allow some UTF-8 encoding (characters for accented letters only).

Delegation Key Payload

The Delegation Key Payload is the portion of the Delegation Payload that contains algorithm name and digest type information.

The algorithm name and digest type name will be determined by the values you enter. You do not need to set the name on the payload. If you do, it will be discarded.

The valid values for the algorithm element are:

Algorithm Description
5 RSA/SHA-1
7 RSASHA1-NSEC3-SHA1
8 RSA/SHA-256
10 RSA/SHA-512
13 ECDSA Curve P-256 with SHA-256
14 ECDSA Curve P-384 with SHA-384
15 EdDSA Curve Ed25519
16 EdDSA Curve Ed448

The valid values for the digest type element are:

Digest Type Description Digest Length
1 SHA-1 40
2 SHA-256 64
3 MD5 32
4 SHA-384 96

Payload

    <delegationKey xmlns="http://www.arin.net/regrws/core/v1" >
      <algorithm name = ""></algorithm>
      <digest></digest>
      <ttl></ttl>
      <digestType name = ""></digestType>
      <keyTag></keyTag>
    </delegationKey>

Example Payload

<delegationKey xmlns="http://www.arin.net/regrws/core/v1" >
  <algorithm name = "RSA/SHA-1">5</algorithm>
  <digest>0DC99D4B6549F83385214189CA48DC6B209ABB71</digest>
  <ttl>86400</ttl>
  <digestType name = "SHA-1">1</digestType>
  <keyTag>264</keyTag>
</delegationKey>

Attachment Payload

This payload allows you to add attachments to an existing ticket as part of an Add Message call. This Attachment Payload should not be submitted by itself. Also note that the value should be base64-encoded.

Note: Attachments submitted should be base64-encoded.

Payload 

<attachment xmlns="http://www.arin.net/regrws/core/v1" >
  <data></data>
  <filename></filename>
</attachment>

Example Payload 

<attachment xmlns="http://www.arin.net/regrws/core/v1" >
  <data>DATA</data>
  <filename>FILENAME</filename>
</attachment>

Phone Payload

The Phone Payload is used by the POC Payload and as a standalone structure by the Add Phone call.

The number field should be in North American Numbering Plan (NANP) format (###-###-####) if applicable. The extension field is optional and can be left blank or not included in the payload you submit.

Code Meaning
O Used to represent an Office phone number.
F Used to represent a Fax phone number.
M Used to represent a Mobile phone number.

Payload 

<phone xmlns="http://www.arin.net/regrws/core/v1" >
  <type>
    <description></description>
    <code>[O, F, M]</code>
  </type>
  <number></number>
  <extension></extension>
</phone>
Example Payload

<phone xmlns="http://www.arin.net/regrws/core/v1" >
  <type>
    <description>DESCRIPTION</description>
    <code>O</code>
  </type>
  <number>+1.703.227.9840</number>
  <extension>101</extension>
</phone>

Customer Payload

The Customer Payload contains details about a customer.

The main difference between the ORG Payload and Customer Payload is the privateCustomer field. If true, the name and address fields will not be publicly visible when the Org is displayed. If false or not provided, the customer will be visible as if it were an Org. Additionally, the Customer Payload does not have a dbaName, taxId, or orgUrl field, nor does it have any related POCs. Note that dbaName denotes an organization’s “Doing Business As” name and exists for organizations who conduct business and would like to appear in Whois/RDAP as a name other than their legal organization name.

The comment field can be used to display operational information about the customer (Network Operation Center (NOC) hours, website, etc.). All comments must be accurate and operational in nature. ARIN reserves the right to edit or remove public comments. (This field supports UTF-8 encoding in the form of accented characters, but not other UTF-8 values.)

The parentOrgHandle field (optional) contains the handle of the Org from which this customer has been reallocated/reassigned resources.

A customer record consists of at least a name and street address. For customers in the United States and Canada, a state/province (iso3166-2) and postalCode are required. For all other country codes, the iso3166-2 and postalCode fields may be included but are not required.

The following fields are automatically filled in once you submit the payload, and should be left blank:

  • handle
  • registrationDate

When performing a modify, if you include these fields with a different value from the original, omit them entirely, or leave them blank, it will return an error.

Note: The iso3166-2 field represents the ISO standard for the state/province code for the ISO3166-1 countries. For more information, refer to the Country Payload section.

Payload

<customer xmlns="http://www.arin.net/regrws/core/v1" >
  <customerName></customerName>
  <iso3166-1>
    <name></name>
    <code2></code2>
    <code3></code3>
    <e164></e164>
  </iso3166-1>
  <handle></handle>
  <streetAddress>
    <line number = ""></line>
  </streetAddress>
  <city></city>
  <iso3166-2></iso3166-2>
  <postalCode></postalCode>
  <comment>
    <line number = ""></line>
  </comment>
  <parentOrgHandle></parentOrgHandle>
  <registrationDate></registrationDate>
  <privateCustomer>[true, false]</privateCustomer>
</customer>

Example Payload

<customer xmlns="http://www.arin.net/regrws/core/v1" >
  <customerName>CUSTOMERNAME</customerName>
  <iso3166-1>
    <name>UNITED STATES</name>
    <code2>US</code2>
    <code3>USA</code3>
    <e164>1</e164>
  </iso3166-1>
  <handle>CUST</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>

ORG Payload

The ORG Payload provides details about an organization, including their address and contact information.

The main difference between the ORG Payload and Customer Payload is the privateCustomer field, which an ORG Payload does not contain.

The comment field can be used to display operational information about the customer (NOC hours, website, etc.). All comments must be accurate and operational in nature. ARIN reserves the right to edit or remove public comments. (This field supports UTF-8 encoding in the form of accented characters, but not other UTF-8 values.)

The following fields are automatically filled in once you submit the payload, and should be left blank:

  • handle
  • registrationDate

The following fields may not be modified:

  • orgName
  • dbaName

Note that dbaName denotes an organization’s “Doing Business As” name and exists for organizations who conduct business and would like to appear in Whois/RDAP as a name other than their legal organization name.

Required fields:

  • orgName
  • streetAddress
    • iso3166-2 and postalCode for United States and Canada
  • pocLinks
    • Only one admin contact
    • At least one technical contact
    • At least one abuse contact

The ORG payload can optionally contain:

If you alter, modify, or omit these fields when performing a ORG Modify, you will receive an error.

The element name orgURL is meant for a Referral Whois (RWhois) server hostname and port, not for the URL of the company’s website. RWhois is a protocol typically run on port 4321 and is described in RFC 2167.

For information on the pocLinks field, see the POC Link Payload.

The iso-3166-1 field refers to an international standard for country codes. More information is available at:

http://en.wikipedia.org/wiki/ISO_3166-1.

The iso-3166-2 refers to an international standard for state, province, county, or other relevant subdivisions as defined by each country. More information is available at:

http://en.wikipedia.org/wiki/ISO_3166-2

  • ISO-3166-1 is mandatory for all Orgs.
  • ISO-3166-2 is required for U.S. and Canada.

Payload

<org xmlns="http://www.arin.net/regrws/core/v1" >
  <iso3166-1>
    <name></name>
    <code2></code2>
    <code3></code3>
    <e164></e164>
  </iso3166-1>
  <streetAddress>
    <line number = ""></line>
  </streetAddress>
  <city></city>
  <iso3166-2></iso3166-2>
  <postalCode></postalCode>
  <comment>
    <line number = ""></line>
  </comment>
  <registrationDate></registrationDate>
  <handle></handle>
  <orgName></orgName>
  <dbaName></dbaName>
  <taxId></taxId>
  <orgUrl></orgUrl>
  <pocLinks>
    <pocLinkRef>
    </pocLinkRef>
  </pocLinks>
</org>

Example Payload

<org xmlns="http://www.arin.net/regrws/core/v1" >
  <iso3166-1>
    <name>UNITED STATES</name>
    <code2>US</code2>
    <code3>USA</code3>
    <e164>1</e164>
  </iso3166-1>
  <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>
  <registrationDate>Mon Nov 07 14:04:28 EST 2011</registrationDate>
  <handle>ARIN</handle>
  <orgName>ORGNAME</orgName>
  <dbaName>DBANAME</dbaName>
  <taxId>TAXID</taxId>
  <orgUrl>ORGURL</orgUrl>
  <pocLinks>
    <pocLinkRef>
    </pocLinkRef>
  </pocLinks>
</org>

Ticket Payload

The Ticket Payload contains details about a submitted ticket. Some calls using this payload will be automatically processed. Others may require manual intervention by ARIN staff, in which case this payload will provide details regarding your request.

The following fields are automatically completed by Reg-RWS, and should be left blank:

  • ticketNo
  • createdDate
  • resolvedDate
  • closedDate
  • updatedDate
  • webTicketType
  • webTicketResolution

If you alter, modify, or omit these fields when performing a Ticket Modify, you will receive an error.

Web Ticket Resolution

Value Meaning
ACCEPTED Your changes have been accepted by ARIN. This resolution applies to edits, profile updates, etc.
DENIED Your changes have been denied by ARIN. This resolution applies to edits, profile updates, etc.
ABANDONED The ticket has been closed because it sat idle, with no interaction from the customer, for too long.
ANSWERED Your question has been answered. This resolution only applies to questions.
PROCESSED A long-running task has completed execution. This applies to report generation, deletes of large networks, etc.
DUPLICATE Your request was a duplicate to a previously opened ticket.
WITHDRAWN Your request was closed by you.
UNSUCCESSFUL Your request was unsuccessful.
OTHER If the final state of your ticket doesn’t fall into the above categories, it will be marked as OTHER.

Web Ticket Status

Value Meaning
PENDING_CONFIRMATION An e-mail was sent to you requesting you to confirm your e-mail and/or intended action.
PENDING_REVIEW Your ticket is pending review by an ARIN service department.
PENDING_CUSTOMER_REVIEW A ticket created by the ARIN staff on your behalf, which requires your confirmation.
ASSIGNED Your ticket has been assigned to an individual within the ARIN organization.
IN_PROGRESS Your ticket is being actively worked on by an individual within the ARIN organization. It may be waiting for a response from you.
WAIT_LIST Your ticket involves an IPv4 request which is awaiting fulfillment as resources become available. For details, visit the IPv4 Waiting List page.
RESOLVED Your ticket has been resolved. You may request further assistance if it has not been completed to your satisfaction.
CLOSED Your ticket has been closed and all work completed.
APPROVED Your ticket has been approved.
ANY A value to represent all ticket statuses. This value should only be used when searching tickets.
ANY_OPEN A value to represent all ticket statuses other than CLOSED. This value should only be used when searching tickets.

Web Ticket Type

Value Meaning
ANY A value to represent all possible types. This value should only be used when searching tickets.
ASN_REQUEST Type denotes an ASN request.
ASSOCIATIONS_REPORT Type denotes a background report process for associations.
CREATE_DELEGATED_RESOURCE_CERTIFICATE Type denotes create delegated resource certificate request.
CREATE_RESOURCE_CERTIFICATE Type denotes create resource certificate request.
CREATE_ROA Type denotes a create ROA request.
CREATE_UPDOWN_RESOURCE_CERTIFICATE Type denotes create updown resource certificate request.
EDIT_BILLING_CONTACT_INFO Type denotes a Billing Contact Info update request.
EDIT_ORG_NAME Type denotes an organization name change ticket.
END_USER_IPV4_REQUEST Type denotes an end user IPv4 request.
END_USER_IPV6_REQUEST Type denotes an end user IPv6 request.
IPV4_DETAILED_REASSIGN Type denotes an IPv4 detailed reassignment request.
IPV4_REALLOCATE Type denotes an IPv4 reallocation request.
IPV4_SIMPLE_REASSIGN Type denotes an IPv4 simple reassignment request.
IPV6_DETAILED_REASSIGN Type denotes an IPv6 reassignment request.
IPV6_REALLOCATE Type denotes an IPv6 reallocation request.
ISP_IPV4_REQUEST Type denotes ISP IPv4 request.
ISP_IPV6_REQUEST Type denotes ISP IPv6 request.
MEMBERSHIP_REQUEST Type denotes a request for General Membership in ARIN.
NET_DELETE_REQUEST Type denotes a background process for net deletion.
ORG_CREATE Type denotes an organization create ticket.
ORG_RECOVERY Type denotes an organization recovery ticket.
PAID_MEMBERSHIP_REQUEST This type has been replaced by MEMBERSHIP_REQUEST but can still be searched for.
POC_RECOVERY Type denotes a POC recovery ticket.
PSP_REQUEST Type denotes a Premier Support Plan (PSP) request ticket.
QUESTION Type denotes a question ticket.
REASSIGNMENT_REPORT Type denotes a background report process for reassignments.
TRANSFER_LISTING_SERVICE Type denotes a transfer listing service ticket.
TRANSFER_PREAPPROVAL Type denotes a pre-approval Specified Transfer (NRPM 8.3) ticket.
TRANSFER_RECIPIENT_82 Type denotes a recipient Merger and Acquisition Transfer (NRPM 8.2) ticket.
TRANSFER_RECIPIENT_83 Type denotes a recipient organization Specified Transfer (NRPM 8.3) ticket.
TRANSFER_RECIPIENT_84 Type denotes a recipient organization Inter-RIR Transfer (NRPM 8.4) ticket.
TRANSFER_SOURCE_83 Type denotes a source organization Specified Transfer (NRPM 8.3) ticket.
TRANSFER_SOURCE_84 Type denotes a source organization Inter-RIR Transfer (NRPM 8.4) ticket.
UPDATE_UPDOWN_IDENTITY Type denotes an update to the child request XML for your designated Certificate Authority.
USER_REASSIGNMENT_REPORT Type denotes a request for report of all downstream networks and free blocks.
WHOWAS_ACCESS Type denotes a WhoWas access request.
WHOWAS_REPORT Type denotes a background report process for a WhoWas report.

Payload

The body of the payload will vary depending on the action requested. Message elements will not be included if the ticket has no messages or a Get Ticket Payload List or Get Ticket Summaries call is used.

<ticket
  xmlns="http://www.arin.net/regrws/core/v1"
  xmlns:ns2="http://www.arin.net/regrws/messages/v1"
  xmlns:ns4="http://www.arin.net/regrws/shared-ticket/v1" >         
  <messages>
    <message>
      <ns2:messageId></ns2:messageId>
      <ns2:createdDate></ns2:createdDate>
      <subject></subject>
      <text>
        <line number = ""></line>
      </text>
      <category>[NONE, JUSTIFICATION]</category>
      <attachments>
        <attachment>
          <data></data>
          <filename></filename>
        </attachment>
      </attachments>
    </message>
  </messages>
  <ticketNo></ticketNo>
  <ns4:shared>[true, false]</ns4:shared>
  <ns4:orgHandle></ns4:orgHandle>
    <createdDate></createdDate>
    <resolvedDate></resolvedDate>
    <closedDate></closedDate>
    <updatedDate></updatedDate>
      <webTicketType>[ASN_REQUEST, ASSOCIATIONS_REPORT, CREATE_DELEGATED_RESOURCE_CERTIFICATE, CREATE_RESOURCE_CERTIFICATE, CREATE_ROA, CREATE_UPDOWN_RESOURCE_CERTIFICATE, EDIT_BILLING_CONTACT_INFO, EDIT_ORG_NAME, END_USER_IPV4_REQUEST, END_USER_IPV6_REQUEST, IPV4_DETAILED_REASSIGN, IPV4_REALLOCATE, IPV4_SIMPLE_REASSIGN, IPV6_DETAILED_REASSIGN, IPV6_REALLOCATE, ISP_IPV4_REQUEST, ISP_IPV6_REQUEST, MEMBERSHIP_REQUEST, NET_DELETE_REQUEST, ORG_CREATE, ORG_RECOVERY, PAID_MEMBERSHIP_REQUEST, POC_RECOVERY, PSP_REQUEST, QUESTION, REASSIGNMENT_REPORT, TRANSFER_LISTING_SERVICE, TRANSFER_PREAPPROVAL, TRANSFER_RECIPIENT_82, TRANSFER_RECIPIENT_83, TRANSFER_RECIPIENT_84, TRANSFER_SOURCE_83, TRANSFER_SOURCE_84, UPDATE_UPDOWN_IDENTITY, USER_REASSIGNMENT_REPORT, WHOWAS_ACCESS, WHOWAS_REPORT, ANY]</webTicketType>
      <webTicketStatus>[PENDING_CONFIRMATION, PENDING_REVIEW, ASSIGNED, IN_PROGRESS, RESOLVED, CLOSED, APPROVED, ANY, ANY_OPEN]</webTicketStatus>
<webTicketResolution>[ACCEPTED, DENIED, ABANDONED, ANSWERED, PROCESSED, DUPLICATE, WITHDRAWN, UNSUCCESSFUL, OTHER]</webTicketResolution>
</ticket>

Example Payload

<ticket
  xmlns="http://www.arin.net/regrws/core/v1"
  xmlns:ns2="http://www.arin.net/regrws/messages/v1"
  xmlns:ns4="http://www.arin.net/regrws/shared-ticket/v1" >
  <messages>
    <message>
    <ns2:messageId>MESSAGEID</ns2:messageId>
    <ns2:createdDate>Tue Feb 28 17:41:17 EST 2012</ns2:createdDate>
      <subject>SUBJECT</subject>
        <text>
          <line number = "1">Line 1</line>
        </text>
      <category>NONE</category>
      <attachments>
        <attachment>
          <data>DATA</data>
          <filename>FILENAME</filename>
        </attachment>
      </attachments>
    </message>
  </messages>
  <ticketNo>TICKETNO</ticketNo>
  <ns4:shared>true</ns4:shared>
  <ns4:orgHandle>ORGHANDLE</ns4:orgHandle>
  <createdDate>Mon Nov 07 14:04:29 EST 2011</createdDate>
  <resolvedDate>Mon Nov 07 14:04:29 EST 2011</resolvedDate>
  <closedDate>Mon Nov 07 14:04:29 EST 2011</closedDate>
  <updatedDate>Mon Nov 07 14:04:29 EST 2011</updatedDate>
  <webTicketType>POC_RECOVERY</webTicketType>
  <webTicketStatus>PENDING_CONFIRMATION</webTicketStatus>
  <webTicketResolution>ACCEPTED</webTicketResolution>
</ticket>

Payload When msgRefs Field is Specified as true

When performing the Get Ticket Details or Get Ticket Payload List calls, the following payload will be returned when the msgRefs field is specified as true.

<ticket
  xmlns="http://www.arin.net/regrws/core/v1"
  xmlns:ns2="http://www.arin.net/regrws/messages/v1">
  <messageReferences>
    <messageReference>
      <messageId></messageId>
      <attachmentReferences>
        <attachmentReference>
          <attachmentFilename></attachmentFilename>
          <attachmentId></attachmentId>
        </attachmentReference>
      </attachmentReferences>
    </messageReference>
  </messageReferences>
  <ticketNo></ticketNo>
  <createdDate></createdDate>
  <resolvedDate></resolvedDate>
  <closedDate></closedDate>
  <updatedDate></updatedDate>
  <webTicketType>[ASN_REQUEST, ASSOCIATIONS_REPORT, CREATE_DELEGATED_RESOURCE_CERTIFICATE, CREATE_RESOURCE_CERTIFICATE, CREATE_ROA, CREATE_UPDOWN_RESOURCE_CERTIFICATE, EDIT_BILLING_CONTACT_INFO, EDIT_ORG_NAME, END_USER_IPV4_REQUEST, END_USER_IPV6_REQUEST, IPV4_DETAILED_REASSIGN, IPV4_REALLOCATE, IPV4_SIMPLE_REASSIGN, IPV6_DETAILED_REASSIGN, IPV6_REALLOCATE, ISP_IPV4_REQUEST, ISP_IPV6_REQUEST, MEMBERSHIP_REQUEST, NET_DELETE_REQUEST, ORG_CREATE, ORG_RECOVERY, PAID_MEMBERSHIP_REQUEST, POC_RECOVERY, PSP_REQUEST, QUESTION, REASSIGNMENT_REPORT, TRANSFER_LISTING_SERVICE, TRANSFER_PREAPPROVAL, TRANSFER_RECIPIENT_82, TRANSFER_RECIPIENT_83, TRANSFER_RECIPIENT_84, TRANSFER_SOURCE_83, TRANSFER_SOURCE_84, UPDATE_UPDOWN_IDENTITY, USER_REASSIGNMENT_REPORT, WHOWAS_ACCESS, WHOWAS_REPORT, ANY </webTicketType>
  <webTicketStatus>[PENDING_CONFIRMATION, PENDING_REVIEW, ASSIGNED, IN_PROGRESS, RESOLVED, CLOSED, APPROVED, ANY, ANY_OPEN]</webTicketStatus>
  <webTicketResolution>[ACCEPTED, DENIED, ABANDONED, ANSWERED, PROCESSED, DUPLICATE, WITHDRAWN, UNSUCCESSFUL, OTHER]</webTicketResolution>
</ticket>

Example Payload When msgRefs Field is Specified as true

<ticket
  xmlns="http://www.arin.net/regrws/core/v1"
  xmlns:ns2="http://www.arin.net/regrws/messages/v1" >
  <messageReferences>
    <messageReference>
      <messageId>MESSAGEID</messageId>
      <attachmentReferences>
        <attachmentReference>
          <attachmentFilename>ATTACHMENTFILENAME</attachmentFilename>
          <attachmentId>ATTACHMENTID</attachmentId>
        </attachmentReference>
      </attachmentReferences>
    </messageReference>
  </messageReferences>
  <ticketNo>TICKETNO</ticketNo>
  <createdDate>Tue Jan 25 16:17:18 EST 2011</createdDate>
  <resolvedDate>Tue Jan 25 16:17:18 EST 2011</resolvedDate>
  <closedDate>Tue Jan 25 16:17:18 EST 2011</closedDate>
  <updatedDate>Tue Jan 25 16:17:18 EST 2011</updatedDate>
  <webTicketType>POC_RECOVERY</webTicketType>
  <webTicketStatus>PENDING_CONFIRMATION</webTicketStatus>
  <webTicketResolution>ACCEPTED</webTicketResolution>
</ticket>

Route Listing Payload

Visit Viewing a List of route Objects.

RPKI Transaction Payload

The RPKI Transaction Payload describes a list of ROAs to be deleted and a list of ROAs to be created.

The autoRenewed and roaSpecAdd.roaSpec.roaHandle fields are only set by the server in the response.

Note: As part of the 4 November 2024 release, and the introduction of an IRR Auto-Manager, the RPKI Transaction Payload has been updated.

At creation, autoLink behavior is controlled entirely by the “roaSpec:autoLink” tag. If “roaSpec:autoLink” is set to true on the request, every “roaResources” for that ROA will be autolinked to an appropriate route/route6 object (creating them if necessary). The “roaSpecResource:autolinked” tag is informational, and only set in the response.

You can look up the autoLinked route/route6 object using the REST API.

<rpkiTransaction
  xmlns="http://www.arin.net/regrws/rpki/v1" >
  <roaSpecDelete>
    <roaHandle autoLink = ""></roaHandle>
    <roaHandle autoLink = ""></roaHandle>
  </roaSpecDelete>
  <roaSpecAdd>
    <roaSpec>
      <autoLink></autoLink>
      <asNumber></asNumber>
      <name></name>
      <resources>
        <roaSpecResource>
          <autoLinked></autoLinked>
          <startAddress></startAddress>
          <cidrLength></cidrLength>
        </roaSpecResource>
      </resources>
    </roaSpec>
    <roaSpec>
      <autoLink></autoLink>
      <asNumber></asNumber>
      <name></name>
      <resources>
        <roaSpecResource>
          <autoLinked></autoLinked>
          <startAddress></startAddress>
          <cidrLength></cidrLength>
          <maxLength></maxLength>
        </roaSpecResource>
        <roaSpecResource>
          <autoLinked></autoLinked>
          <startAddress></startAddress>
          <cidrLength></cidrLength>
          <maxLength></maxLength>
        </roaSpecResource>
      </resources>
    </roaSpec>
  </roaSpecAdd>
</rpkiTransaction>

Example

<rpkiTransaction
  xmlns="http://www.arin.net/regrws/rpki/v1" >
  <roaSpecDelete>
    <roaHandle autolink = "true">24ab90ed2342355e12343aca12345150</roaHandle>
    <roaHandle autolink = "true">1980ed234270809a079700723b987088</roaHandle>
  </roaSpecDelete>
  <roaSpecAdd>
    <roaSpec>
      <autoLink>true</autoLink>
      <asNumber>64496</asNumber>
      <name>headquarters</name>
      <resources>
        <roaSpecResource>
          <startAddress>192.0.2.0</startAddress>
          <cidrLength>24</cidrLength>
        </roaSpecResource>
      </resources>
    </roaSpec>
    <roaSpec>
      <autoLink>true</autoLink>
      <asNumber>64497</asNumber>
      <name>cloud_offerings</name>
      <resources>
        <roaSpecResource>
          <startAddress>198.51.100.0</startAddress>
          <cidrLength>24</cidrLength>
          <maxLength>25</maxLength>
        </roaSpecResource>
        <roaSpecResource>
          <startAddress>203.0.113.0</startAddress>
          <cidrLength>24</cidrLength>
          <maxLength>25</maxLength>
        </roaSpecResource>
      </resources>
    </roaSpec>
  </roaSpecAdd>
</rpkiTransaction>

ROA Spec Payload

The ROA Spec Payload provides information about a ROA, including:

  • asNumber: The Autonomous System Number (ASN) from which the route will originate.
  • name: A descriptive name associated with the ASN.
  • notValidBefore/notValidAfter: Dates that the ROA is valid.
  • cidrLength: Prefix that indicates the number of bits in the IP address block that is routed.
  • startAddress/endAddress: Beginning and end IP addresses of the IP address block that is routed.
  • ipVersion: IP version of the address block.
  • maxLength: “Specifies the maximum length of IP address prefix that the AS is authorized to advertise” (RFC 9582: A Profile for Route Origin Authorizations (ROAs).)
  • autoRenewed: Boolean specifying whether ARIN will automatically renew the ROA.

Payload

<roaSpec xmlns="http://www.arin.net/regrws/rpki/v1" >
  <asNumber></asNumber>
  <name></name>
  <notValidAfter></notValidAfter>
  <notValidBefore></notValidBefore>
  <resources>
    <cidrLength></cidrLength>
    <endAddress></endAddress>
    <ipVersion></ipVersion>
    <maxLength></maxLength>
    <startAddress></startAddress>
    <autoLinked></autoLinked>
  </resources>
  <roaHandle></roaHandle>
</roaSpec>

Example

<roaSpec>
  <ns5:asNumber>64496</ns5:asNumber>
  <ns5:name>IANA-RSVD</ns5:name>
  <ns5:notValidAfter>2020-12-13T00:00:00-05:00</ns5:notValidAfter>
  <ns5:notValidBefore>2019-12-14T00:00:00-05:00</ns5:notValidBefore>
  <ns5:resources>
    <ns5:cidrLength>32</ns5:cidrLength>
    <ns5:endAddress>2001:db8:ffff:ffff:ffff:ffff:ffff:ffff
    </ns5:endAddress>
    <ns5:ipVersion>6</ns5:ipVersion>
    <ns5:maxLength>48</ns5:maxLength>
    <ns5:startAddress>2001:db8:0:0:0:0:0:0</ns5:startAddress>
    <ns5:autoLinked>true</ns5:autoLinked>
  </ns5:resources>
  <ns5:roaHandle>58bc1674f7784054ba743b9f5c23885b</ns5:roaHandle>
</roaSpec>

Legacy Route Origin Authorization (ROA) Payload

Note: To receive the benefit of auto-renewing ROAs, please use the new ROA creation service.

The ROA Payload allows for ROA request submissions and is used when creating a ROA request.

Please complete the roaData field using the following format:

versionNumber|signingTime|name|originAS|validityStartDate|validityEndDate|startAddress|cidrLength|maxLength|

Note that startAddress|cidrLength|maxLength| are repeated for each resource. The versionNumber field must be set to 1, as it is currently the only supported version. The signingTime is a timestamp specifying when the ROA data was signed, specified in seconds since the unix epoch (January 1, 1970). The name field may contain any name of your choosing and is for your own identification purposes. The originAs field is the AS that will be authorized to announce the resources present in the roaData. The validityStartDate and validityEndDate specifies the date range during which your ROA must be considered valid, and must be within the range of your resource certificate. These dates must be specified in the mm-dd-yyyy format.

The signature field of the RoaPayload is the signed base64 encoding of the roaData field. More information about ROA signing may be found on ARIN’s Resource Public Key Infrastructure (RPKI) FAQ.

Payload

<roa xmlns="http://www.arin.net/regrws/rpki/v1" >
  <signature></signature>
  <roaData></roaData>
</roa>

Example Payload

<roa xmlns="http://www.arin.net/regrws/rpki/v1" >
  <signature>RGWqTwh/z7+mC/R9VJIcb1eUgTTigB8xFV+DYzEhim4wM00==</signature>
  <roaData>1|1340135296|My First ROA|1234|05-25-2011|05-25-2012|10.0.0.0|8|16|</roaData>
</roa>

NET Block Payload

The NET Block Payload contains details on the NET block of the network specified. The NET Block Payload is a nested element of a NET Payload. See NET Payload for additional details.

When submitting a NET Block Payload as part of the NET Payload, the IP addresses provided in the startAddress and endAddress elements can be non-zero-padded (for example, 10.0.0.255) or zero-padded (for example, 010.000.000.255). The payload returned will always express IP addresses as zero-padded.

The description field will be determined by the type you specify and may be left blank.

NET Type

Code Meaning
A Used to represent a Reallocation network.
AF Used to represent an AFRINIC allocated network.
AP Used to represent an APNIC allocated network.
AR Used to represent an ARIN allocated network.
AV Used to represent an ARIN early reservation network.
DA Used to represent a Direct Allocation network.
FX Used to represent an AFRINIC transferred network.
IR Used to represent an IANA reserved network.
IU Used to represent an IANA special use network.
LN Used to represent a LACNIC allocated network.
LX Used to represent a LACNIC transferred network.
PV Used to represent an APNIC early reservation network.
PX Used to represent an APNIC early registration network.
RN Used to represent a RIPE allocated network.
RV Used to represent a RIPE early reservation network.
RX Used to represent a RIPE NCC Transferred network.
S Used to represent a Reassigned network.

Payload

<netBlock xmlns="http://www.arin.net/regrws/core/v1" >
  <type>[A, AF, AP, AR, AV, DA, FX, IR, IU, LN, LX, PV, PX, RN, RV, RX, S]</type>
  <description></description>
  <startAddress></startAddress>
  <endAddress></endAddress>
  <cidrLength></cidrLength>
</netBlock>

Example Payload

<netBlock xmlns="http://www.arin.net/regrws/core/v1" >
  <type>A</type>
  <description>DESCRIPTION</description>
  <startAddress>010.000.000.000</startAddress>
  <endAddress>010.000.000.255</endAddress>
  <cidrLength>24</cidrLength>
</netBlock>

NET Payload

The NET Payload contains details about an IPv4 or IPv6 network.

If you send a NET Payload and need to fill in the netBlock field, only one of the endAddress or the cidrLength fields are required; not both. Reg-RWS will calculate the other for you, and the details for both will be returned in any call resulting in a NET Payload.

If you specify a NET type, it must be one of the valid codes located in the table under NET Block Payload. If you do not provide a type, Reg-RWS will determine it for you, depending on which call you are using. The version field may contain a value of “4” or “6,” depending on the type of NET you are referring to. If left blank, this field will be completed for you based on the startAddress.

When submitting a NET Payload, the IP addresses provided in the startAddress and endAddress fields can be non-zero-padded (i.e., 10.0.0.255) or zero-padded (i.e., 010.000.000.255). The payload returned will always express IP addresses as zero-padded.

The comment field can be used to display operational information about the customer (Network Operation Center [NOC] hours, website, etc.). All comments must be accurate and operational in nature. ARIN reserves the right to edit or remove public comments. (This field supports UTF-8 encoding in the form of accented characters, but not other UTF-8 values.)

The following fields are automatically filled in once you submit the payload, and should be left blank:

  • handle
  • registrationDate

If you alter or omit these fields when performing a NET Modify, you will receive an error.

The orgHandle and customerHandle elements are mutually exclusive. Depending on the type of call this payload is being used for, you are required to assign either a customer or an Org. One of the two values will be present at all times.

  • Simple reassignments require that you complete the customerHandle field (remove the orgHandle field).
  • Reallocations and detailed reassignments require you to complete the orgHandle field (remove the customerHandle field).

Note that the originASes and pocLinks fields will not auto-populate. These items must be manually added.

The following fields may not be modified during a NET Modify:

  • version
  • orgHandle
  • netBlock
  • customerHandle
  • parentNetHandle

If you alter or omit these fields when performing a NET Modify, you will receive an error.

The NET payload can optionally contain:

For information on the pocLinks field, see the POC Link Payload.

Payload

<net xmlns="http://www.arin.net/regrws/core/v1" >
  <version></version>
  <comment>
    <line number = ""></line>
  </comment>
  <registrationDate></registrationDate>
  <orgHandle></orgHandle>
  <handle></handle>
  <netBlocks>
    <netBlock>
      <type>[A, AF, AP, AR, AV, DA, FX, IR, IU, LN, LX, PV, PX, RN, RV, RX, S]</type>
      <description></description>
      <startAddress></startAddress>
      <endAddress></endAddress>
      <cidrLength></cidrLength>
    </netBlock>
  </netBlocks>
  <customerHandle></customerHandle>
  <parentNetHandle></parentNetHandle>
  <netName></netName>
  <originASes>
    <originAS></originAS>
  </originASes>
  <pocLinks>
    <pocLinkRef>
    </pocLinkRef>
  </pocLinks>
</net>

Example Payload

<net xmlns="http://www.arin.net/regrws/core/v1" >
  <version>4</version>
  <comment>
    <line number = "1">Line 1</line>
  </comment>
  <registrationDate>Tue Jan 25 16:17:18 EST 2011</registrationDate>
  <orgHandle>ARIN</orgHandle>
  <handle>NET-10-0-0-0-1</handle>
  <netBlocks>
    <netBlock>
      <type>A</type>
      <description>DESCRIPTION</description>
      <startAddress>010.000.000.000</startAddress>
      <endAddress>010.000.000.255</endAddress>
      <cidrLength>24</cidrLength>
    </netBlock>
  </netBlocks>
  <customerHandle>C12341234</customerHandle>
  <parentNetHandle>PARENTNETHANDLE</parentNetHandle>
  <netName>NETNAME</netName>
  <originASes>
    <originAS>AS102</originAS>
  </originASes>
  <pocLinks>
    <pocLinkRef>
    </pocLinkRef>
  </pocLinks>
</net>

This payload is a nested object within ORG and NET Payloads, explaining the POC Handle(s) associated with that object and the function it is serving.

The description field will be completed automatically based on the information provided in the function field and should be left blank.

Note: Admin (AD) POCs may not be added to NETs.

Function

Code Meaning
AD Used to represent an Admin Point of Contact.
AB Used to represent an Abuse Point of Contact.
N Used to represent a NOC Point of Contact.
T Used to represent a Tech Point of Contact.
R Used to represent a Routing Point of Contact.
D Used to represent a DNS Point of Contact.

Payload

<pocLinkRef xmlns="http://www.arin.net/regrws/core/v1"
  description = ""
  handle = ""
  function = "[AD, AB, N, T, R, D]">
</pocLinkRef>

Example Payload

<pocLinkRef xmlns="http://www.arin.net/regrws/core/v1"
  description = "Admin"
  handle = "ARIN-HOSTMASTER"
  function ="AD">
</pocLinkRef>

Attachment Reference Payload

This payload is contained within a Message Payload returned during a Get Ticket Payload List call, or within a Message Reference Payload when a Get Ticket Payload List call is performed and the msgRefs parameter is specified as true. This AttachmentReferencePayload should not be submitted by itself.

Payload

<attachmentReference xmlns="http://www.arin.net/regrws/core/v1" >
  <attachmentFilename></attachmentFilename>
  <attachmentId></attachmentId>
</attachmentReference>

Example Payload

<attachmentReference xmlns="http://www.arin.net/regrws/core/v1" >
  <attachmentFilename>ATTACHMENTFILENAME</attachmentFilename>
  <attachmentId>ATTACHMENTID</attachmentId>
</attachmentReference>

Message Reference Payload

This payload is a nested element of a Ticket Payload returned when a Get Ticket Payload List call is performed and the msgRefs parameter is specified as true. You can then request a Get Ticket Message call with a specified MessageID, and will be returned a MessagePayload. This MessageReferencePayload should not be submitted by itself.

Payload 

<messageReference xmlns="http://www.arin.net/regrws/core/v1" >
  <attachmentReferences>
    <attachmentReference>
      <attachmentFilename></attachmentFilename>
      <attachmentId></attachmentId>
    </attachmentReference>
  </attachmentReferences>
  <messageId></messageId>
</messageReference>

Example Payload

<messageReference xmlns="http://www.arin.net/regrws/core/v1">
  <attachmentReferences>
    <attachmentReference>
      <attachmentFilename>ATTACHMENTFILENAME</attachmentFilename>
      <attachmentId>ATTACHMENTID</attachmentId>
    </attachmentReference>
  </attachmentReferences>
  <messageId>MESSAGEID</messageId>
</messageReference>

Component Error Payload

Component Error Payloads represent individual component errors in the Error Payload.

Payload

<component xmlns="http://www.arin.net/regrws/core/v1" >
  <name></name>
  <message></message>
</component>

Example Payload

<component xmlns="http://www.arin.net/regrws/core/v1" >
  <name>NAME</name>
  <message>MESSAGE</message>
</component>

Error Payload

The Error Payload is returned when any call encounters errors and it contains the reason for the error.

Code

Code Meaning
E_AUTHENTICATION The API key specified in your URL either does not exist, or is not associated with/authoritative over the object specified in your URL/payload.
E_BAD_REQUEST The request you made was invalid. The most common reasons are a bad URL, invalid parameter types, invalid parameters, or your MIME type wasn’t properly set to application/xml or application/rpsl. The source of your error will likely be an error in your REST client, and the error message will provide details for the fix.
E_ENTITY_VALIDATION This database object failed to pass ARIN’s validation (fields were missing or contained invalid characters, etc.).
E_SCHEMA_VALIDATION The XML data you provided did not pass the RelaxNG schema validation. Please try validating your XML content against RelaxNG prior to submitting it.
E_METHOD_NOT_ALLOWED For a 405 (Method Not Allowed) HTTP response.
E_NOT_ACCEPTABLE For a 406 (Not Acceptable) HTTP response.
E_NOT_REMOVEABLE The database object you specified was not able to be removed due to current associations/links to other objects. Remove those links/associations and try again.
E_OBJECT_NOT_FOUND The database object you specified was not found in our database.
E_OUTAGE The Reg-RWS server is currently undergoing maintenance and is not available.
E_TOO_MANY_REQUESTS For a 429 (Too Many Requests) HTTP response.
E_UNSPECIFIED A universal error code for unspecified errors.
E_UNSUPPORTED_MEDIA_TYPE For a 415 (Unsupported Media Type) HTTP response.

Payload

<error xmlns="http://www.arin.net/regrws/core/v1" >
  <message></message>
  <code>[E_AUTHENTICATION, E_BAD_REQUEST, E_ENTITY_VALIDATION, E_SCHEMA_VALIDATION, _E_METHOD_NOT_ALLOWED, E_NOT_ACCEPTABLE, E_NOT_REMOVEABLE, E_OBJECT_NOT_FOUND, E_OUTAGE, E_TOO_MANY_REQUESTS, E_UNSPECIFIED, E_UNSUPPORTED_MEDIA_TYPE]</code>
  <components>
    <component>
      <name></name>
      <message></message>
    </component>
  </components>
  <additionalInfo>
    <message></message>
  </additionalInfo>
</error>

Example Payload

<error xmlns="http://www.arin.net/regrws/core/v1" >
  <message>MESSAGE</message>
  <code>E_SCHEMA_VALIDATION</code>
  <components>
    <component>
      <name>NAME</name>
      <message>MESSAGE</message>
    </component>
  </components>
  <additionalInfo>
    <message>MESSAGE</message>
  </additionalInfo>
</error>

Phone Type Payload

This represents a phone type. It is a nested element of Phone Payload and should not be submitted by itself. The description field will be automatically filled when using the information in the code field and should be left blank.

Code

Code Meaning
O Used to represent an Office phone number.
F Used to represent a Fax phone number.
M Used to represent a Mobile phone number.

Payload

<type xmlns="http://www.arin.net/regrws/core/v1" >
  <description></description>
  <code>[O, F, M]</code>
</type>

Example Payload

<type xmlns="http://www.arin.net/regrws/core/v1" >
  <description>OFFICE</description>
  <code>O</code>
</type>

Message Payload

This payload allows the sending of additional information to an existing ticket and enables users to get a specific message and any accompanying attachment(s). The body of the payload will vary depending on the action requested.

Note: Attachments submitted should be base64-encoded.

The following fields are automatically completed by Reg-RWS, and should be left blank:

  • messageId
  • createdDate

Category

Message Meaning
NONE Used if there is no category type.
JUSTIFICATION Used to represent justification message type.

Payload When Adding a Message to a Ticket

When performing the Add Message call as specified in the Methods page, use the following payload:

<message xmlns="http://www.arin.net/regrws/core/v1" >
  <subject></subject>
  <text>
    <line number = ""></line>
  </text>
  <category>[NONE, JUSTIFICATION]</category>
  <attachments>
    <attachment>
      <data></data>
      <filename></filename>
    </attachment>
  </attachments>
</message>

Example Payload When Adding a Message to a Ticket

<message xmlns="http://www.arin.net/regrws/core/v1" >
  <subject>SUBJECT</subject>
  <text>
    <line number = "1">Line 1</line>
  </text>
  <category>NONE</category>
  <attachments>
    <attachment>
      <data>DATA</data>
      <filename>FILENAME</filename>
    </attachment>
  </attachments>
</message>

Payload When Getting a Specific Message

When performing the Get Message call as specified in the Methods page, use the following payload:

<message
  xmlns="http://www.arin.net/regrws/core/v1"
  xmlns:ns2="http://www.arin.net/regrws/messages/v1" >
  <ns2:messageId><ns2:messageId>
  <ns2:createdDate><ns2:createdDate>
  <subject></subject>
  <text>
    <line number = ""></line>
  </text>
  <category>[NONE, JUSTIFICATION]</category>
    <attachmentReferences>
      <attachmentReference>
        <attachementFilename></attachmentFilename>
        <attachmentId></attachmentId>
      </attachmentReference>
    </attachmentReferences>
</message>

Example Payload When Getting a Specific Message

<message
  xmlns="http://www.arin.net/regrws/core/v1"
  xmlns:ns2="http://www.arin.net/regrws/messages/v1" >
  <ns2:messageId>MESSAGEID</ns2:messageId>
  <ns2:createdDate>Tue Feb 28 17:41:17 EST 2012</ns2:createdDate>
  <subject>SUBJECT</subject>
  <text>
    <line number = "1">Line 1</line>
  </text>
  <category>NONE</category>
  <attachmentReferences>
    <attachmentReference>
      <attachementFilename>ATTACHMENTFILENAME</attachmentFilename>
      <attachmentId>ATTACHMENTID</attachmentId>
    </attachmentReference>
  </attachmentReferences>
</message>

Multi-line Text Payload

Defines a multi-line field, such as public comments or address.

Payload

<multiline xmlns="http://www.arin.net/regrws/core/v1" >
  <line number = ""></line>
</multiline>

Example Payload

<multiline xmlns="http://www.arin.net/regrws/core/v1" >
  <line number = "1">Line 1</line>
</multiline>

Country Payload

The Country Payload identifies a country using two-digit, three-digit, and/or e164 codes.

The name and e164 (ITU-T E.164 international calling codes) fields are not required. Either the two-digit (code2) or three-digit (code3) code fields must be specified. If you specify both, they must match the same country.

For a listing of two- and three-digit codes, visit:

https://www.arin.net/about/welcome/region/

For a listing of ITU-T E.164 international calling codes, visit:

http://www.itu.int/dms_pub/itu-t/opb/sp/T-SP-E.164D-2009-PDF-E.pdf

Payload

<iso3166-1 xmlns="http://www.arin.net/regrws/core/v1" >
  <name></name>
  <code2></code2>
  <code3></code3>
  <e164></e164>
</iso3166-1>

Example Payload

<iso3166-1 xmlns="http://www.arin.net/regrws/core/v1" >
  <name>UNITED STATES</name>
  <code2>US</code2>
  <code3>USA</code3>
  <e164>1</e164>
</iso3166-1>

Ticketed Request Payload

The Ticket Request Payload provides details about a ticket or a NET. If the call you are using may result in a NET being returned, a Ticketed Request Payload is returned. This may occur when performing a reallocation/reassignment. The Ticketed Request Payload will have an embedded NET Payload representing the NET that was created. See Reassign NET and Reallocate NET for more details.

Payload

<ticketedRequest
  xmlns="http://www.arin.net/regrws/core/v1"
  xmlns:ns2="http://www.arin.net/regrws/messages/v1" >
  <ticket>
    <messages>
      <message>
        <ns2:messageId></ns2:messageId>
        <ns2:createdDate></ns2:createdDate>
        <subject></subject>
        <text>
          <line number = ""></line>
        </text>
        <category>[NONE, JUSTIFICATION]</category>
        <attachments>
          <attachment>
            <data></data>
            <filename></filename>
          </attachment>
        </attachments>
      </message>
    </messages>
    <ticketNo></ticketNo>
    <createdDate></createdDate>
    <resolvedDate></resolvedDate>
    <closedDate></closedDate>
    <updatedDate></updatedDate>
    <webTicketType>[ASN_REQUEST, ASSOCIATIONS_REPORT, CREATE_DELEGATED_RESOURCE_CERTIFICATE, CREATE_RESOURCE_CERTIFICATE, CREATE_ROA, CREATE_UPDOWN_RESOURCE_CERTIFICATE, EDIT_BILLING_CONTACT_INFO, EDIT_ORG_NAME, END_USER_IPV4_REQUEST, END_USER_IPV6_REQUEST, IPV4_DETAILED_REASSIGN, IPV4_REALLOCATE, IPV4_SIMPLE_REASSIGN, IPV6_DETAILED_REASSIGN, IPV6_REALLOCATE, ISP_IPV4_REQUEST, ISP_IPV6_REQUEST, MEMBERSHIP_REQUEST, NET_DELETE_REQUEST, ORG_CREATE, ORG_RECOVERY, PAID_MEMBERSHIP_REQUEST, POC_RECOVERY, PSP_REQUEST, QUESTION, REASSIGNMENT_REPORT, TRANSFER_LISTING_SERVICE, TRANSFER_PREAPPROVAL, TRANSFER_RECIPIENT_82, TRANSFER_RECIPIENT_83, TRANSFER_RECIPIENT_84, TRANSFER_SOURCE_83, TRANSFER_SOURCE_84, UPDATE_UPDOWN_IDENTITY, USER_REASSIGNMENT_REPORT, WHOWAS_ACCESS, WHOWAS_REPORT, ANY]</webTicketType>
    <webTicketStatus>[PENDING_CONFIRMATION, PENDING_REVIEW, ASSIGNED, IN_PROGRESS, RESOLVED, CLOSED, APPROVED, ANY, ANY_OPEN]</webTicketStatus>
    <webTicketResolution>[ACCEPTED, DENIED, ABANDONED, ANSWERED, PROCESSED, DUPLICATE, WITHDRAWN, UNSUCCESSFUL, OTHER]</webTicketResolution>
  </ticket>
  <net>
    <version></version>
    <comment>
      <line number = ""></line>
    </comment>
    <registrationDate></registrationDate>
    <orgHandle></orgHandle>
    <handle></handle>
    <netBlocks>
      <netBlock>
        <type>[A, AF, AP, AR, AV, DA, FX, IR, IU, LN, LX, PV, PX, RN, RV, RX, S]</type>
        <description></description>
        <startAddress></startAddress>
        <endAddress></endAddress>
        <cidrLength></cidrLength>
      </netBlock>
    </netBlocks>
    <customerHandle></customerHandle>
    <parentNetHandle></parentNetHandle>
    <netName></netName>
    <originASes>
      <originAS></originAS>
    </originASes>
    <pocLinks>
      <pocLinkRef>
      </pocLinkRef>
    </pocLinks>
  </net>
</ticketedRequest>

Example Payload

<ticketedRequest
  xmlns="http://www.arin.net/regrws/core/v1"
  xmlns:ns2="http://www.arin.net/regrws/messages/v1" >
  <ticket>
    <messages>
      <message>
        <ns2:messageId>MESSAGEID</ns2:messageId>
        <ns2:createdDate>Tue Feb 28 17:41:17 EST 2012</ns2:createdDate>
        <subject>SUBJECT</subject>
        <text>
          <line number = "1">Line 1</line>
        </text>
        <category>NONE</category>
        <attachments>
          <attachment>
            <data>DATA</data>
            <filename>FILENAME</filename>
          </attachment>
        </attachments>
      </message>
    </messages>
    <ticketNo>TICKETNO</ticketNo>
    <createdDate>Tue Jan 25 16:17:18 EST 2011</createdDate>
    <resolvedDate>Tue Jan 25 16:17:18 EST 2011</resolvedDate>
    <closedDate>Tue Jan 25 16:17:18 EST 2011</closedDate>
    <updatedDate>Tue Jan 25 16:17:18 EST 2011</updatedDate>
    <webTicketType>POC_RECOVERY</webTicketType>
    <webTicketStatus>PENDING_CONFIRMATION</webTicketStatus>
    <webTicketResolution>ACCEPTED</webTicketResolution>
  </ticket>
</ticketedRequest>
<ticketedRequest xmlns="http://www.arin.net/regrws/core/v1" >
  <net>
    <version>4</version>
    <comment>
      <line number = "1">Line 1</line>
    </comment>
    <registrationDate>Tue Jan 25 16:17:18 EST 2011</registrationDate>
    <orgHandle>ARIN</orgHandle>
    <handle>NET-10-0-0-0-1</handle>
    <netBlocks>
      <netBlock>
        <type>A</type>
        <description>DESCRIPTION</description>
        <startAddress>010.000.000.000</startAddress>
        <endAddress>010.000.000.255</endAddress>
        <cidrLength>24</cidrLength>
      </netBlock>
    </netBlocks>
    <customerHandle>C12341234</customerHandle>
    <parentNetHandle>PARENTNETHANDLE</parentNetHandle>
    <netName>NETNAME</netName>
    <originASes>
      <originAS>AS102</originAS>
    </originASes>
    <pocLinks>
      <pocLinkRef>
      </pocLinkRef>
    </pocLinks>
  </net>
</ticketedRequest>

POC Payload

The POC Payload provides information about a POC.

The comment field can be used to display operational information about the Customer (NOC hours, website, etc.). All comments must be accurate and operational in nature. ARIN reserves the right to edit or remove public comments. (This field supports UTF-8 encoding in the form of accented characters, but not other UTF-8 values.)

The following fields are automatically filled in once you submit the payload and should be left blank:

  • handle
  • registrationDate

The following fields may not be modified:

  • contactType
  • firstName
  • middleName
  • lastName

If you alter, modify, or omit these fields when performing a Modify POC, you will receive an error.

The iso-3166-1 field refers to an international standard for country codes. More information is available at:

http://en.wikipedia.org/wiki/ISO_3166-1

The iso-3166-2 refers to an international standard for state, province, county, or other relevant subdivisions as defined by each country. More information is available at:

http://en.wikipedia.org/wiki/ISO_3166-2

  • ISO-3166-1 is mandatory for all Points of Contact.
  • ISO-3166-2 is required for U.S. and Canada.

Required fields:

  • At least one email address
  • contactType
  • Company name (if the contactType is ROLE)
  • First name (if the contact type is PERSON)
  • Last name
  • At least one office phone number
  • streetAddress
    • iso3166-2 and postalCode for United States and Canada

Contact Type

Code Meaning
PERSON Used to represent a person contact type.
ROLE Used to represent a role contact type.

Note: If defining this Point Of Contact as a Role Point Of Contact:

  • companyName is required
  • role name must be entered in the lastName
  • firstName must be left blank

Payload

<poc xmlns="http://www.arin.net/regrws/core/v1" >
  <iso3166-2></iso3166-2>
  <iso3166-1>
    <name></name>
    <code2></code2>
    <code3></code3>
    <e164></e164>
  </iso3166-1>
  <emails>
    <email></email>
  </emails>
  <streetAddress>
    <line number = ""></line>
  </streetAddress>
  <city></city>
  <postalCode></postalCode>
  <comment>
    <line number = ""></line>
  </comment>
  <registrationDate></registrationDate>
  <handle></handle>
  <contactType>[PERSON, ROLE]</contactType>
  <companyName></companyName>
  <firstName></firstName>
  <middleName></middleName>
  <lastName></lastName>
  <phones>
    <phone>
      <type>
        <description></description>
        <code>[O, F, M]</code>
      </type>
      <number></number>
      <extension></extension>
    </phone>
  </phones>
</poc>

Example Payload

<poc xmlns="http://www.arin.net/regrws/core/v1" >
  <iso3166-2>VA</iso3166-2>
  <iso3166-1>
    <name>UNITED STATES</name>
    <code2>US</code2>
    <code3>USA</code3>
    <e164>1</e164>
  </iso3166-1>
  <emails>
    <email>you@example.com</email>
  </emails>
  <streetAddress>
    <line number = "1">Line 1</line>
  </streetAddress>
  <city>Chantilly</city>
  <postalCode>20151</postalCode>
  <comment>
    <line number = "1">Line 1</line>
  </comment>
  <registrationDate>Mon Nov 07 14:04:28 EST 2011</registrationDate>
  <handle>ARIN-HOSTMASTER</handle>
  <contactType>PERSON</contactType>
  <companyName>COMPANYNAME</companyName>
  <firstName>FIRSTNAME</firstName>
  <middleName>MIDDLENAME</middleName>
  <lastName>LASTNAME</lastName>
  <phones>
    <phone>
      <type>
        <description>DESCRIPTION</description>
        <code>O</code>
      </type>
      <number>+1.703.227.9840</number>
      <extension>101</extension>
    </phone>
  </phones>
</poc>

Delegation Payload

The Delegation Payload allows you to define the details of a DNS delegation, including nameservers and Delegation Signer (DS) keys.

The name field is automatically generated after you submit the payload, and should be left blank.

If the time-to-live (TTL) value is not specified, the nameserver will use the TTL of the zone. You can specify a different TTL value; for example, if you want the nameserver to be queried more often (to keep up with DNS changes) or less often (if your DNS won’t be changing often and you want the DNS data to be cached on the nameserver for longer periods). The TTL value is in seconds; for example, 86400 = 1 day.

Payload

<delegation
  xmlns="http://www.arin.net/regrws/core/v1"
  xmlns:ns2="http://www.arin.net/regrws/ttl/v1 >
  <name></name>
  <delegationKeys>
    <delegationKey>
      <algorithm name = ""></algorithm>
      <digest></digest>
        <ttl></ttl>
      <digestType name = ""></digestType>
      <keyTag></keyTag>
    </delegationKey>
  </delegationKeys>
  <nameservers>
    <nameserver ns2:ttl="value"></nameserver>
  </nameservers>
</delegation>

Example Payload

<delegation
  xmlns="http://www.arin.net/regrws/core/v1"
  xmlns:ns2="http://www.arin.net/regrws/ttl/v1 >
  <name>0.76.in-addr.arpa.</name>
  <delegationKeys>
    <delegationKey>
      <algorithm name = "RSA/SHA-1">5</algorithm>
      <digest>0DC99D4B6549F83385214189CA48DC6B209ABB71</digest>
      <ttl>86400</ttl>
      <digestType name = "SHA-1">1</digestType>
      <keyTag>264</keyTag>
    </delegationKey>
  </delegationKeys>
  <nameservers>
    <nameserver ns2:ttl="86400">NS4.DOMAIN.COM</nameserver>
    <nameserver>NS4.DOMAIN.COM</nameserver>
  </nameservers>
</delegation>

Payload List Payload

This payload is used as a container, to store multiple payloads and return them back to the customer. This list payload will act as a wrapper for ticket searching, the setting of phones on Points of Contact, etc.

Payload

<collection
  xmlns="http://www.arin.net/regrws/core/v1"
  xmlns:ns2="http://www.arin.net/regrws/messages/v1" >
  <phone>
    <type>
      <description></description>
      <code>[O, F, M]</code>
    </type>
    <number></number>
    <extension></extension>
  </phone>
  <ticket>
    <messages>
      <message>
        <ns2:messageId></ns2:messageId>
        <ns2:createdDate></ns2:createdDate>
        <subject></subject>
        <text>
          <line number = ""></line>
        </text>
        <category>[NONE, JUSTIFICATION]</category>
        <attachments>
          <attachment>
            <data></data>
            <filename></filename>
          </attachment>
        </attachments>
      </message>
    </messages>
    <ticketNo></ticketNo>
    <createdDate></createdDate>
    <resolvedDate></resolvedDate>
    <closedDate></closedDate>
    <updatedDate></updatedDate>
    <webTicketType>[ASN_REQUEST, ASSOCIATIONS_REPORT, CREATE_DELEGATED_RESOURCE_CERTIFICATE, CREATE_RESOURCE_CERTIFICATE, CREATE_ROA, CREATE_UPDOWN_RESOURCE_CERTIFICATE, EDIT_BILLING_CONTACT_INFO, EDIT_ORG_NAME, END_USER_IPV4_REQUEST, END_USER_IPV6_REQUEST, IPV4_DETAILED_REASSIGN, IPV4_REALLOCATE, IPV4_SIMPLE_REASSIGN, IPV6_DETAILED_REASSIGN, IPV6_REALLOCATE, ISP_IPV4_REQUEST, ISP_IPV6_REQUEST, MEMBERSHIP_REQUEST, NET_DELETE_REQUEST, ORG_CREATE, ORG_RECOVERY, PAID_MEMBERSHIP_REQUEST, POC_RECOVERY, PSP_REQUEST, QUESTION, REASSIGNMENT_REPORT, TRANSFER_LISTING_SERVICE, TRANSFER_PREAPPROVAL, TRANSFER_RECIPIENT_82, TRANSFER_RECIPIENT_83, TRANSFER_RECIPIENT_84, TRANSFER_SOURCE_83, TRANSFER_SOURCE_84, UPDATE_UPDOWN_IDENTITY, USER_REASSIGNMENT_REPORT, WHOWAS_ACCESS, WHOWAS_REPORT, ANY]</webTicketType>
    <webTicketStatus>[PENDING_CONFIRMATION, PENDING_REVIEW, ASSIGNED, IN_PROGRESS, RESOLVED, CLOSED, APPROVED, ANY, ANY_OPEN]</webTicketStatus>
    <webTicketResolution>[ACCEPTED, DENIED, ABANDONED, ANSWERED, PROCESSED, DUPLICATE, WITHDRAWN, UNSUCCESSFUL, OTHER]</webTicketResolution>
  </ticket>
  <delegation>
    <name></name>
    <delegationKeys>
      <delegationKey>
        <algorithm name = ""></algorithm>
        <digest></digest>
        <digestType name = ""></digestType>
        <keyTag></keyTag>
      </delegationKey>
    </delegationKeys>
    <nameservers>
      <nameserver></nameserver>
    </nameservers>
  </delegation>
</collection>

Example Payload

<collection
  xmlns="http://www.arin.net/regrws/core/v1"
  xmlns:ns2="http://www.arin.net/regrws/messages/v1" >
  <phone>
    <type>
      <description>DESCRIPTION></description>
      <code>O</code>
    </type>
    <number>+1.703.227.9840</number>
    <extension>101</extension>
  </phone>
</collection>
<collection xmlns="http://www.arin.net/regrws/core/v1" >
  <ticket>
    <messages>
      <message>
        <ns2:messageId>MESSAGEID</ns2:messageId>
        <ns2:createdDate>Tue Feb 28 17:41:17 EST 2012
        </ns2:createdDate>
          <subject>SUBJECT</subject>
             <text>
              <line number = "1">Line 1</line>
            </text>
        <category>NONE</category>
        <attachments>
          <attachment>
            <data>DATA</data>
            <filename>FILENAME</filename>
              </attachment>
        </attachments>
      </message>
    </messages>
    <ticketNo>TICKETNO</ticketNo>
    <createdDate>Mon Nov 07 14:04:29 EST 2011</createdDate>
    <resolvedDate>Mon Nov 07 14:04:29 EST 2011</resolvedDate>
    <closedDate>Mon Nov 07 14:04:29 EST 2011</closedDate>
    <updatedDate>Mon Nov 07 14:04:29 EST 2011</updatedDate>
    <webTicketType>POC_RECOVERY</webTicketType>
    <webTicketStatus>PENDING_CONFIRMATION</webTicketStatus>
    <webTicketResolution>ACCEPTED</webTicketResolution>
  </ticket>
</collection>
<collection xmlns="http://www.arin.net/regrws/core/v1" >
  <delegation>
    <name>0.76.in-addr.arpa.</name>
    <delegationKeys>
    <delegationKey>
        <algorithm name = "RSA/SHA-1">5</algorithm>
        <digest>0DC99D4B6549F83385214189CA48DC6B209ABB71</digest>
        <digestType name = "SHA-1">1</digestType>
        <keyTag>264</keyTag>
      </delegationKey>
    </delegationKeys>
    <nameservers>
      <nameserver>NS1.DOMAIN.COM</nameserver>
      <nameserver>NS2.DOMAIN.COM</nameserver>
    </nameservers>
  </delegation>
</collection>

Automating Record Management with Reg-RWS

Related

Registration Services Help Desk
7:00 AM to 7:00 PM ET
Phone: +1.703.227.0660
Fax: +1.703.997.8844

Tips for Calling the Help Desk