Your IP address could not be determined at this time.

RESTful Methods

Table of Contents

  1. Delegations
  2. NETs
  3. POCs
  4. Customers
  5. Tickets
  6. Route Origin Authorizations (ROAs)
  7. Reports
  8. ORGs
  9. Error Codes

Introduction

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.

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

Each entry below 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.

1. Delegations

    1. Get
    2. Modify
    3. Add Nameserver
    4. Delete Nameserver
    5. Delete Multiple Nameservers

Delegations are entries that relate IP addresses to domain names using the Domain Name System (DNS) of the Internet. Delegations contain the information necessary for Reverse DNS, including the associated nameservers, and DNS Delegation Signer (DS Record) information. Unlike the other objects, delegations are not given a handle. They are searched for within Whois using a delegation name, like 0.192.in-addr.arpa.

Note: Any changes made to Delegations using these calls may take up to 24 hours to appear in the DNS.

a. Get

This call will return a payload containing details about the Delegation specified in your URL.

Definition
Method GET
URL /rest/delegation/DELEGATIONNAME?apikey=APIKEY
Content NONE
Returns Delegation Payload

b. Modify

This call will modify the details of the Delegation specified in your URL. When making this call, attach a Delegation Payload containing the details of the Delegation you intend to modify. To ensure accuracy, use Get Delegation to get the most current information before making changes. This call returns a payload containing that Delegation's information as it exists after modification.

Definition
Method PUT
URL /rest/delegation/DELEGATIONNAME?apikey=APIKEY
Content Delegation Payload
Returns Delegation Payload

c. Add Nameserver

This call will add the single nameserver specified in your URL to the Delegation specified in your URL, and return a payload containing that Delegation's information after the nameserver has been added.

Definition
Method POST
URL /rest/delegation/DELEGATIONNAME/nameserver/NAMESERVER?apikey=APIKEY
Content NONE
Returns Delegation Payload

d. Delete Nameserver

This call will delete the single nameserver specified in your URL from the Delegation specified in your URL, and return a payload containing that Delegation's information after the nameserver has been deleted.

If Reg-RWS returns an error code and/or Error Payload to you when performing this call, refer to the Error Codes section.

Definition
Method DELETE
URL /rest/delegation/DELEGATIONNAME/nameserver/NAMESERVER?apikey=APIKEY
Content NONE
Returns Delegation Payload

e. Delete Multiple Nameservers

This call will delete all nameservers from the Delegation specified in your URL, and return a payload containing that Delegation's information after the nameservers have been deleted.

Definition
Method DELETE
URL /rest/delegation/DELEGATIONNAME/nameservers?apikey=APIKEY
Content NONE
Returns Delegation Payload

2. NETS

    1. Get
    2. Delete
    3. Modify
    4. Get Delegations
    5. Create Recipient ORG
    6. Create Recipient Customer
    7. Reassign
    8. Reallocate

Network records (NETs) define a range of IPv4 or IPv6 addresses and show the organizations and POCs with authority over them. There are four main types of resource records within the database:

  • Direct Allocation: IP address space allocated directly from ARIN to an organization. The organization may reallocate or reassign that space to downstream customers.
  • Direct Assignment: IP address space assigned directly from ARIN to an organization for its own exclusive use.
  • Reallocation: IP address space allocated from an organization (the upstream) to a downstream customer. The downstream customer may reallocate or reassign that space further.
  • Reassignment: IP address space assigned from an organization (the upstream) to a downstream customer for its own exclusive use.
    • Detailed Reassignment: Address space assigned to a customer who may need to:
      subdelegate the addresses to their own customers maintain their own in-addr.arpa delegation
      display their own point of contact (POC) information
    • Simple Reassignment: Address space assigned to a customer that does NOT require the above capabilities.

Note: The following calls work with IPv4 and IPv6 addresses.

a. Get

This call will return a payload containing details about the NET specified in your URL.

Definition
Method GET
URL /rest/net/NETHANDLE?apikey=APIKEY
Content NONE
Returns NET Payload

b. Delete

This call will generate an automatically-processed ticketed request to delete the NET specified in your URL. If that NET has no NETs reallocated or reassigned from them, this call will return a Ticketed Request Payload with an embedded NET Payload containing details of the deleted network.

If the NET being deleted has "child" NETs (reallocations or reassignments made from within that network range), this method will generate a ticketed request to delete the NET specified in your URL, and will return a Ticketed Request Payload with an embedded Ticket Payload containing the details of the request. Wait until that Ticket is successfully processed before reissuing that space to other customers.

This call will only delete reassignments or reallocations. If attempted on a direct assignment/allocation NET, you will receive an Error Payload. Please use ASK ARIN when logged into ARIN Online to return direct assignments/allocations.

Note: Deleting a Customer NET obtained via a simple reassignment will not delete the Customer. This must be done separately using Delete Customer.

Definition
Method DELETE
URL /rest/net/NETHANDLE?apikey=APIKEY
Content NONE
Returns Ticketed Request Payload

c. Modify

This call will modify the details of the NET specified in your URL. When making this call, attach a NET Payload containing the details of the NET you intend to modify. To ensure accuracy, use Get NET to get the most current information before making changes. This call returns a payload containing that NET's information as it exists after modification.

Definition
Method PUT
URL /rest/net/NETHANDLE?apikey=APIKEY
Content NET Payload
Returns NET Payload

d. Get Delegations

This call will return a list of Delegation Payloads containing information about Delegations made from the NET specified in your URL.

Definition
Method GET
URL /rest/net/NETHANDLE/delegations?apikey=APIKEY
Content NONE
Returns Payload List

e. Create Recipient ORG

This call will create an ORG using the details in the ORG Payload you provide, and the handle in your URL specifying the parent NET from which this ORG will be receiving a detailed reallocation/reassignment (for simple reassignments, use Create Recipient Customer). This call will then return a payload containing information about this newly-created 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/org?apikey=APIKEY
Content ORG Payload
Returns ORG Payload

f. Create Recipient Customer

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 (for detailed reallocations/reassignments, use Create Recipient ORG). This call will then return a payload contianing information about this newly-created Customer.

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
Returns Customer Payload

g. Reassign

Definition
Method PUT
URL /rest/net/PARENTNETHANDLE/reassign?apikey=APIKEY
Content NET Payload
Returns Ticketed Request Payload

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.

There are two types of reassignments that can take place: simple and detailed.

  • Simple: Registering resources to a Customer (similar to an ORG, but without customer contact information). To create a Customer, use Create Recipient Customer. Customers automatically inherit the POCs of their parent ORG.
    • To perform a simple reassignment, specify a Customer in the NET Payload you send.
  • Note: Due to database constraints, a single Customer may not be tied to multiple simple reassignments. If you wish to perform multiple simple reassignments to the same organization, it is recommended to:

    • Create an ORG for each reassignment, or
    • Use Create Recipient ORG and perform a detailed reassignment to it, as ORGs may have an unlimited amount of NETs or ASNs associated with them.
  • Detailed: Registering resources to an ORG. To create an ORG for a detailed reassignment, use Create Recipient ORG.
    • To perform a detailed reassignment, specify an ORG in the NET Payload you send.

If there are no errors, this call will return a Ticketed Request Payload. If the reassignment can be automatically processed, this payload will contain a NET Payload with the details of the reassignment. If the request cannot be automatically processed, the Ticketed Request Payload returned will have an embedded Ticket Payload containing the details of the Ticket created for the request. If a reassignment cannot be processed, the call will return an Error Payload.

A simple reassignment is rejected if:

  1. The Customer specified in your payload does not exist.
  2. You are attempting to perform a simple reassignment using a NET with POCs still associated with it.
  3. The NET name specified in your payload contains characters that are not letters, numbers, hyphens, or spaces.
  4. The parent NET specified in your payload is:
    1. Nonexistent
    2. Not active
    3. Not a direct assignment/allocation.
  5. IP addresses within the range specified in your payload extend beyond that of the parent NET.
  6. IP addresses within the range specified in your payload overlap with existing reservations or registrations that have the same parent NET.
  7. The API Key used is not associated with an ARIN Online user who is linked to a POC with authority over the parent NET or its ORG.
  8. The API Key specified in your URL is not active.
  9. The reassignment request is smaller than a /64 of IPv6 space.

A detailed reassignment is rejected if:

  1. The ORG specified in your payload does not exist.
  2. The ORG specified in your payload does not have all of the following:
    1. One Admin POC
    2. At least one Tech POC
    3. At least one Abuse POC
  3. POCs are currently associated with the NET you are performing a detailed reassignment with )POC relationships are not allowed to be added during network creation).
  4. The NET name specified in your payload contains characters that are not letters, numbers, hyphens, or spaces.
  5. The parent NET specified in your payload is:
    1. Nonexistent
    2. Not active
    3. Not a direct assignment/allocation.
  6. IP addresses within the range specified in your payload extend beyond the range of the Parent NET.
  7. IP addresses within the range specified in your payload overlap existing NETs with the same parent NET.
  8. The API Key specified in your URL is not associated with a web user who is linked to an Admin or Tech POC for the parent NET or it's ORG.
  9. The API Key specified in your URL is not active.

If Reg-RWS returns an error code and/or Error Payload to you when performing this call, refer to the Error Codes section.

h. Reallocate

Definition
Method PUT
URL /rest/net/PARENTNETHANDLE/reallocate?apikey=APIKEY
Content NET Payload
Returns Ticketed Request Payload

This call performs a reallocation from the NET specified in your URL using the recipient information contained in the NET Payload you provide. Reallocations are given to an ORG for further reallocation or reassignment.

If the reallocation can be automatically processed, this call will return a Ticketed Request Payload will include a NET Payload with details of the reallocation. If the request cannot be automatically processed, the Ticketed Request Payload returned will have an embedded Ticket Payload containing the details of the Ticket created for the request. A reallocation requires manual intervention if:

If the request cannot be auto-processed, the Ticketed Request Payload returned will have an embedded Ticket Payload containing the details of the Ticket created for the request. If a reallocation is automatically rejected, the call will return an Error Payload. Reallocations will be automatically rejected if:

  1. The ORG specified in your payload does not exist
  2. The ORG specified in your payload does not have all of the following:
    1. One Admin POC
    2. At least one Tech POC
    3. At least one Abuse POC
  3. POCs are currently associated with the NET you are performing a detailed reassignment with )POC relationships are not allowed to be added during network creation).
  4. The NET name specified in your payload contains characters that are not letters, numbers, hyphens, or spaces.
  5. The parent NET specified in your payload is:
    1. Nonexistent
    2. Not active
    3. Not a direct assignment/allocation.
  6. IP addresses within the range specified in your payload extend beyond the range of the parent NET.
  7. IP addresses within the range specified in your payload overlap existing NETs with the same parent NET.
  8. The API Key specified in your URL is not associated with a web user who is linked to an Admin or Tech POC for the parent NET or it's ORG.
  9. The API Key specified in your URL is not active.

If Reg-RWS returns an error code and/or Error Payload to you when performing this call, refer to the Error Codes section.

3. POCs

    1. Get
    2. Delete
    3. Create
    4. Modify
    5. Add Phone
    6. Delete Phone
    7. Add Email
    8. Delete Email

POCs are standalone objects that define a person, and include the person’s mailing address and contact information, and a listing of any organizations or resources that POC has authority over. POCs can also define role accounts like noc@, abuse@, etc. An individual’s area of responsibility is defined by how their POC is connected to an organization or the resources of an organization. For more information on POCs, visit https://www.arin.net/knowledge/database.html.

Note: POCs tied to an organization are automatically inherited by any resource that organization has authority over. There is no need to create multiple POCs to accomplish this or to list the same POC on both an ORG and its resources.

a. Get

This call will return a payload containing details about the POC specified in your URL.

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

b. Delete

This call will delete the POC specified in your URL, and return a payload containing that POC's information as it existed just before deletion.

If Reg-RWS returns an error code and/or Error Payload to you when performing this call, refer to the Error Codes section.

Note: You may only remove POCs that are not associated with an ORG or a NET. Any POC associated with an ORG or NET must first be disassociated using Modify ORG, Modify NET, or Remove ORG POC.

Definition
Method DELETE
URL /rest/poc/POCHANDLE?apikey=APIKEY
Content NONE
Returns POC Payload

c. Create

This call will create a POC using the details in the POC Payload you provide, and will return a payload containing information about this newly-created POC. If MAKELINK is specified as true, the call will also link the ARIN Online account to whom the API Key specified in your URL belongs. If MAKELINK is omitted, or specified as false, then no link will be created, which means that user will not be able to make any changes to that POC.

If Reg-RWS returns an error code and/or Error Payload to you when performing this call, refer to the Error Codes section.

Note: Only one ARIN Online user may be linked to a non-role account POC.

Definition
Method POST
URL /rest/poc;makeLink=MAKELINK?apikey=APIKEY
Content POC Payload
Returns POC Payload

d. Modify

This call will modify the details of the POC specified in your URL. When making this call, attach a POC Payload containing the details of the POC you intend to modify. To ensure accuracy, use Get POC to get the most current information before making changes. This call returns a payload containing that POC's information as it exists after modification.

If Reg-RWS returns an error code and/or Error Payload to you when performing this call, refer to the Error Codes section.

Note: If you specify a phone number and/or email address within the POC Payload you send, all current phone numbers and/or email addresses currently listed in that POC will be replaced by those specified. To add or remove phone numbers or email addresses from a POC, use Add Phone, Delete Phone, Add Email or Delete Email.

Definition
Method PUT
URL /rest/poc/POCHANDLE?apikey=APIKEY
Content POC Payload
Returns POC Payload

e. Add Phone

This call associates a phone number specified in your Phone Payload with the POC specified in your URL, and returns a payload containing information about the newly-added phone number. This call does not erase any phone numbers from the specified POC.

If Reg-RWS returns an error code and/or Error Payload to you when performing this call, refer to the Error Codes section.

Definition
Method PUT
URL /rest/poc/POCHANDLE/phone?apikey=APIKEY
Content Phone Payload
Returns Phone Payload

f. Delete Phone

This call removes one or more phone number specified in your URL from the POC specified in your URL, and returns a payload containing information about the newly-deleted phone number(s). This call does not erase any phone numbers from the specified POC. At least one of the two phone number identifiers in your URL (NUMBER and TYPE) must be included. Both fields may be found in the POC Payload for the POC you intend to alter. NUMBER refers simply to the phone number itself, while TYPE refers to the category that number fits into (O for Office, F for Fax, M for Mobile).

  • If you do not include NUMBER, every phone number matching the TYPE you specify will be removed.
  • If you do not include TYPE, every phone number matching the NUMBER you specify will be removed.

Note: NUMBER must match the existing phone number exactly, including all "+" and "-" characters.

Definition
Method DELETE
URL /rest/poc/POCHANDLE/phone/NUMBER;type=TYPE?apikey=APIKEY
Content NONE
Returns Payload List

g. Add Email

This call associates the email address specified in your URL with the POC specified in your URL, and returns a payload containing information about the POC as it exists after adding the email address.

If Reg-RWS returns an error code and/or Error Payload to you when performing this call, refer to the Error Codes section.

Definition
Method POST
URL /rest/poc/POCHANDLE/email/EMAIL?apikey=APIKEY
Content NONE
Returns POC Payload

h. Delete Email

This call removes an email address specified in your URL from the POC specified in your URL, and returns a payload containing information about the POC as it exists after deleting the email address.

If Reg-RWS returns an error code and/or Error Payload to you when performing this call, refer to the Error Codes section.

Definition
Method DELETE
URL /rest/poc/POCHANDLE/email/EMAIL?apikey=APIKEY
Content NONE
Returns POC Payload

4. Customers

    1. Get
    2. Delete
    3. Modify

Customers are organizations associated with ARIN through a provider organization. While searchable in Whois, customers may only have authority over a single network registration: a simple reassignment. Customers may also be made private to keep contact information hidden. RESTful calls relating to Customers usually resemble ORG calls, apart from the different payload being returned. Because Customer creation should only be performed referencing a network that will be reassigned, you will find Create Recipient Customer under the NETs methods section of this document.

a. Get

This call will return a payload containing details about the Customer specified in your URL.

Definition
Method GET
URL /rest/customer/CUSTOMERHANDLE?apikey=APIKEY
Content NONE
Returns Customer Payload

b. Delete

This call will delete the Customer specified in your URL, and return a payload containing that Customer's information as it existed just before deletion.

Definition
Method DELETE
URL /rest/customer/CUSTOMERHANDLE?apikey=APIKEY
Content NONE
Returns Customer Payload

c. Modify

This call will modify the details of the Customer specified in your URL. When making this call, attach a Customer Payload containing the details of the Customer you intend to modify. To ensure accuracy, use Get Customer to get the most current information before making changes. This call returns a payload containing details about the Customer as it exists after modification.

Definition
Method PUT
URL /rest/customer/CUSTOMERHANDLE?apikey=APIKEY
Content Customer Payload
Returns Customer Payload

5. Tickets

    1. Add Message
    2. Modify
    3. Modify Status
    4. Get Ticket Details
    5. Get Ticket Summary
    6. Get Tickets
    7. Get Ticket Summaries
    8. Get Message
    9. Get Attachment

Tickets are requests for ARIN to perform a task. Some Tickets are automatically processed, while others require more interaction with and/or manual approval by ARIN staff. Reg-RWS can access any Ticket related to your ARIN Online account; not just Tickets created using Reg-RWS. When specifying a Ticket number in the URL or as a parameter for any calls, please use this format: 20090526-X1.

a. Add Message

This call will add the message and/or attachment from your Message Payload to the Ticket specified in your URL, and return a payload containing details of that message.

Note: Messages cannot be attached to closed Tickets.

Definition
Method PUT
URL /rest/ticket/TICKETNUMBER/message?apikey=APIKEY
Content Message Payload
Returns Message Payload

b. Modify

This call will modify the details of the Ticket specified in your URL. When making this call, attach a Ticket Payload containing the details of the Ticket you intend to modify. To ensure accuracy, use one of the GET methods below to get the most current Ticket information before making changes. This call returns a payload containing that Ticket's information as it exists after modification.

This call will modify a ticket. The only field which is modifiable is the status and it can only be set to CLOSED if the ticket is already RESOLVED. All other calls to this will result in an error stating that you cannot modify the element.

Note: The msgRefs field is an optional boolean (true/false) parameter. When true, message reference element(s) are returned instead of message element(s).The msgRegs field defaults to false if not set. To avoid passing large payloads, set MSGREFS to true.

If Reg-RWS returns an error code and/or Error Payload to you when performing this call, refer to the Error Codes section.

Definition
Method PUT
URL /rest/ticket/TICKETNUMBER?apikey=APIKEY&msgRefs=MSGREFS
Content Ticket Payload
Returns Ticket Payload

c. Modify Status

This call will modify a ticket status. The only field which is modifiable is the status and it can only be set to CLOSED if the ticket is already RESOLVED. This call does not take a payload.

Definition
Method PUT
URL /rest/ticket/TICKETNUMBER?apikey=APIKEY
Content /rest/ticket/TICKETNUMBER/ticketStatus/TICKETSTATUS?apikey=APIKEY&msgRefs=MSGREFS
Returns Ticket Payload

d. Get Ticket Details

This call will return a payload containing details about the Ticket specified in your URL, including messages.

Note: msgRefs is an optional parameter in your URL, and may only be specified as "true" or "false" within your URL. If true, the returned Ticket Payload will contain message reference field(s) instead of message element(s). If the Ticket specified in your URL has attachments totaling a size beyond the allowed threshold, you will receive a "413" error and an Error Payload stating the attachment size limit has been exceeded. For these Tickets, you may want to specify the msgRefs parameter as true. You may then perform a Get Message call for the message information.

If Reg-RWS returns an error code and/or Error Payload to you when performing this call, refer to the Error Codes section.

Definition
Method GET
URL /rest/ticket/TICKETNUMBER?apikey=APIKEY&msgRefs=MSGREFS
Content NONE
Returns Ticket Payload

e. Get Ticket Summary

This call will return a payload containing details about the Ticket specified in your URL, without messages.

Definition
Method GET
URL /rest/ticket/TICKETNUMBER/summary?apikey=APIKEY
Content NONE
Returns Ticket Payload

f. Get Tickets

This call will return a Payload List Payload containing a Ticket Payload for each Ticket associated with the API Key specified in your URL.

At least one of the two Ticket identifier fields in your URL (TICKETTYPE and TICKETSTATUS) must be included. These fields are found on theTicket Payload for the Ticket you are referring to (webTicketType and webTicketStatus). TICKETTYPE refers to the category in which theTicket fits (CREATE_ROA, ASN_REQUEST, etc.). TICKETSTATUS refers to the current state that the Ticket is in (ACCEPTED, DENIED, ABANDONED, etc.).

  • If you do not include POCHANDLE, every POC matching the POCFUNCTION you specify will be removed.
  • If you do not include POCFUNCTION, every POC matching the POCHANDLE you specify will be removed.

If Reg-RWS returns an error code and/or Error Payload to you when performing this call, refer to the Error Codes section.

Definition
Method GET
URL /rest/ticket;ticketType=TICKETTYPE;ticketStatus=TICKETSTATUS?apikey=APIKEY
Content NONE
Returns Payload List

g. Get Ticket Summaries

This call will return a Payload List Payload containing a Ticket Payload without message information for each Ticket associated with the API Key specified in your URL.

Definition
Method GET
URL /rest/ticket/summary;ticketType=TICKETTYPE;ticketStatus=TICKETSTATUS?apikey=APIKEY
Content NONE
Returns Payload List

h. Get Message

This call will return a Message Payload containing details about the message specified in your URL. The payload will contain Attachment Reference Payloads rather than directly containing the attachments. In the future, ARIN will introduce a new call allowing the download of a specific attachment using the AttachmentID specified in this payload. The value for the MESSAGEID may be found in the Ticket Payload for the Ticket you are retrieving a message from.

Definition
Method GET
URL /rest/ticket/TICKETNUMBER/message/MESSAGEID?apikey=APIKEY
Content NONE
Returns Ticket Payload

i. Get Attachment

This call returns the contents of the attachment specified in your URL.

Note: HTTP Header Content-Disposition will include the filename and Content-Type will be 'application/octet-stream'.

Definition
Method GET
URL /rest/ticket/TICKETNUMBER/message/MESSAGEID/attachment/ATTACHMENTID?apikey=APIKEY
Content NONE
Returns Response

6. Route Origin Authorizations (ROAs)

The following call allows for Route Origin Authorization (ROA) request submissions. This POST method creates a ROA based on the signed ROA request specified in the ROA Payload. A valid payload will return a Ticket Payload containing the details of the ticketed request. The Ticket Service can be used to obtain additional details about the created ticket.

If a validation error occurs, the signed ROA request is not created and an HTTP 400 (bad request) response containing an Error Payload is returned along with an error code and message explaining the error.

A signed ROA must be submitted in a timely manner. A grace period of 24 hours is given from the time of signing for submission.

Valid values for resource class are:

  • AR (representing ARIN)
  • AP (representing APNIC)
  • RN (representing RIPE)
  • LN (representing LACNIC)
  • AF (representing AFRINIC)

If no value is specified for resource class then the resource class for ARIN (AR) will be used. If Reg-RWS returns an error code and/or Error Payload to you when performing this call, refer to the Error Codes section.

Definition
Method POST
URL /rest/roa/ORGHANDLE;resourceClass=RESOURCECLASS?apikey=APIKEY
Content ROA Payload
Returns Ticket Payload

7. Reports

The following calls provide the ability to request reports. Reassignments and Associations reports are available to all registered ARIN Online users.  However before you can request a WhoWas report, you must request WhoWas access and accept the WhoWas Terms of Use.

a. Request WhoWas ASN Report

ARIN's WhoWas service provides authorized users access to historical registration information for a given IP address or ASN. This call will allow you to request a WhoWas Report for the ASNUMBER you specify.
If successful, a TicketPayload will be returned. You can then use calls specified within the Ticket Service above to check the status of the ticket and get the attached report. Depending on system usage, the time needed to produce the report may vary.

The APIKEY used in the request must belong to an ARIN Online user who is authorized to access WhoWas reports. The authorization process is described at: https://www.arin.net/resources/whowas/

An attempt to request a WhoWas Report by an unauthorized user will result in an HTTP 401 (unauthorized) response containing an E_AUTHENTICATION ErrorPayload. Invalid or inactivated APIKEYs will result in an HTTP 400 (bad request) response.

Note: Your APIKEY does not need to be linked to a POC associated with the ASN; you can request a WhoWas Report for any ASN.

Definition
Method GET
URL /rest/report/whoWas/asn/ASNUMBER?apikey=APIKEY
Content NONE
Returns Ticket Payload

b. Request WhoWas NET Report

ARIN's WhoWas service provides authorized users access to historical registration information for a given IP address or ASN. This call will allow you to request a WhoWas Report for the IPADDRESS. The address must be specified as an IPv4 or IPv6 address (192.0.2.0 or 2001:DB8::), NOT a handle (NET-192-0-2-0-1) or a CIDR prefix (192.0.2.0/24 or 2001:DB8::/32).

If successful, a TicketPayload will be returned. You can then use calls specified within the Ticket Service above to check the status of the ticket and get the attached report. Depending on system usage, the time needed to produce the report may vary.

The APIKEY used in the request must belong to an ARIN Online user who is authorized to access WhoWas reports. The authorization process is described at: https://www.arin.net/resources/whowas/

An attempt to request a WhoWas Report by an unauthorized user will result in an HTTP 401 (unauthorized) response containing an E_AUTHENTICATION ErrorPayload. Invalid or inactivated APIKEYs will result in an HTTP 400 (bad request) response.

Note: Your APIKEY does not need to be linked to a POC associated with the IP Address; you can request a WhoWas Report for any IP Address.

Definition
Method GET
URL /rest/report/whoWas/net/IPADDRESS?apikey=APIKEY
Content NONE
Returns Ticket Payload

b. Request Associations Report

An Associations Report provides:

  • A list of all POCs your ARIN Web account is linked to
  • A list of all organizations those POCs are associated with
  • A list of all number resources those POCs are associated with directly or through the organization
  • The roles served by the POCs on each organization and resource (e.g. Org Admin, Resource Tech)

This call will allow you to request an Associations Report.

If successful, a TicketPayload will be returned. You can then use calls specified within the Ticket Service above to check the status of the ticket and get the attached report. Depending on system usage, the time needed to produce the report may vary.

Note: The APIKEY used in the request must belong to your ARIN Online account. Invalid or inactivated APIKEYs will result in an HTTP 400 (bad request) response.

Definition
Method GET
URL /rest/report/associations?apikey=APIKEY
Content NONE
Returns Ticket Payload

b. Request Reassignment Report

A Reassignment Report lists all sub-delegations for the requested NETHANDLE, as registered in ARIN's Whois directory service via SWIP. ARIN provides Reassignment Reports for IPv4 networks that are a Direct Allocations or Reallocations. This call will allow you to request a Reassignments Report for the specified NETHANDLE.

If successful, a TicketPayload will be returned. You can then use calls specified within the Ticket Service above to check the status of the ticket and get the attached report. Depending on system usage, the time needed to produce the report may vary.

ARIN provides Reassignment Reports for IPv4 networks that are a Direct Allocations or Reallocations. An attempt to request a report for any other type of network will result in an HTTP 400 (bad request) response.

Note: The APIKEY used in the request must belong to an ARIN Online user that is linked to a POC authoritative for the requested network. An attempt to request a Reassignments Report for which such a link does not exist will result in an HTTP 401 (unauthorized) response containing an E_AUTHENTICATION ErrorPayload. Invalid or inactivated APIKEYs will result in an HTTP 400 (bad request) response.

Definition
Method GET
URL /rest/report/reassignment/NETHANDLE?apikey=APIKEY
Content NONE
Returns Ticket Payload

8. ORGs

    1. Get
    2. Delete
    3. Create
    4. Modify
    5. Remove POC
    6. Add POC

An ORG represents an organization that is registered in the ARIN database, and shows the entity’s name, its physical address, and any POCs with authority over it. In addition, all Internet number resources directly assigned or allocated from ARIN, as well as any downstream resources, must be registered to the appropriate ORG. This means you must create an ORG before requesting resources. Any entity may maintain multiple ORGs for different accounts or consolidate all of its resources under a single ORG. For each ORG, there must be at least one Admin, Tech and Abuse POC with authority over it (NOC POCs are optional).

a. Get

This call will return a payload containing details about the ORG specified in your URL.

Definition
Method GET
URL /rest/org/ORGHANDLE?apikey=APIKEY
Content NONE
Returns ORG Payload

b. Delete

This call will delete the ORG specified in your URL, and return a payload containing that ORG's information as it existed just before deletion.

If Reg-RWS returns an error code and/or Error Payload to you when performing this call, refer to the Error Codes section.

Definition
Method DELETE
URL /rest/org/ORGHANDLE?apikey=APIKEY
Content NONE
Returns ORG Payload

c. Create

This call wil generate a Ticket using the details in the ORG Payload you provide. This ticket will be reviewed by ARIN staff. The call will return a payload containing information about this Ticket, which you may then use to retrieve that Ticket's status. Use this method for ORGs intending to request a direct allocation/assignment from ARIN. For detailed reallocations/reassignments, use Create Recipient ORG. For simple reassignments, use Create Recipient Customer.

If Reg-RWS returns an error code and/or Error Payload to you when performing this call, refer to the Error Codes section.

Note: If the API Key specified in your URL is not linked to an Admin or Tech POC for this ORG, the ORG will still be created, but you will not have authorization to make changes to it.

Definition
Method POST
URL /rest/org/?apikey=APIKEY
Content ORG Payload
Returns Ticket Payload

d. Modify

This call will modify the details of the ORG specified in your URL. When making this call, attach an ORG Payload containing the details of the ORG you intend to modify. To ensure accuracy, use Get ORG to get the most current information before making changes. This call returns a payload containing that ORG's information as it exists after modification. If you wish only to add or remove one or multiple POCs from an ORG, you may use Remove POC or Add POC, as they do not require formatting/sending a payload.

If Reg-RWS returns an error code and/or Error Payload to you when performing this call, refer to the Error Codes section.

Note: If any POC information is provided in the ORG payload of the PUT request, all current POCs associated with the ORG will be removed, and replaced with those provided in the request.

Definition
Method PUT
URL /rest/org/ORGHANDLE?apikey=APIKEY
Content ORG Payload
Returns ORG Payload

e. Remove POC

This call will remove one or multiple POCs from the ORG specified in your URL. At least one of the two POC identifiers in your URL (POCHANDLE and POCFUNCTION) must be included. These fields are found on the ORG Payload for the ORG you intend to alter. POCHANDLE defines a particular POC's identity in the database. POCFUNCTION defines its role (Abuse POC, Admin POC, Tech POC, etc.)

  • If you do not include POCHANDLE, every POC matching the POCFUNCTION you specify will be removed.
  • If you do not include POCFUNCTION, every POC matching the POCHANDLE you specify will be removed.

Once the POCs have been removed, the call will return an ORG Payload with information about the ORG as it appears in the database after the POC has been deleted.

Note: Every ORG must have at least one Tech POC. If you attempt to remove all Tech POCs from an ORG, you will receive an error.

If Reg-RWS returns an error code and/or Error Payload to you when performing this call, refer to the Error Codes section.

Definition
Method DELETE
URL /rest/org/ORGHANDLE/poc/POCHANDLE;pocFunction=POCFUNCTION?apikey=APIKEY
Content NONE
Returns ORG Payload

f. Add POC

This call will add a POC to an ORG under a POC function type, all three of which are specified by your URL. Once complete, this call will return an ORG Payload containing information about the ORG you have added POCs to. This payload will contain a list of all POCs assigned to that ORG, in order of function.

Note: All Org IDs must have exactly one Admin POC. If you attempt to add or change an Admin POC, you will receive an error. To change an Admin POC, perform a Modify call instead.

If Reg-RWS returns an error code and/or Error Payload to you when performing this call, refer to the Error Codes section.

Definition
Method PUT
URL /rest/org/ORGHANDLE/poc/POCHANDLE;pocFunction=POCFUNCTION?apikey=APIKEY
Content NONE
Returns ORG Payload

9. Error Codes

The following error codes may occur while using Reg-RWS. If there is a generic status code, i.e. 400 Bad Request, Reg-RWS will also return an Error Payload containing further details about the error and how to resolve it.

Error Codes:

Error Meaning/Causes
400 Bad request. This can be caused by a missing or incorrect API Key, sending information that Reg-RWS cannot validate, or syntax errors within the URL/payload you sent.This error also occurs when you attempt to remove all Tech POCs from an ORG, as all ORGs must have at least one.
401 The API Key used in the request does not belong to an ARIN Online user that is linked to a POC with the authority to modify the specified record. Ensure that the record you specified is one that your POC has authority over, and that your ARIN Online account is linked to that POC.
403 This error indicates a forbidden request. For instance, if you attempt to reallocate resources from a parent NET not associated with the API Key specified in your URL, you will receive this error.
404 The record you identified couldn't be found in the database. For instance, if you get a 404 while trying to modify a POC it probably means Reg-RWS couldn't find a matching POC in the database.
405 Either the wrong method is specified, or the URL contains incorrect information
409 You have attempted to delete something that was still linked to something else in ARIN's database. For example, you tried to delete POC that is still linked to an ORG or NET, or you tried to delete a Customer that is still linked to a NET. This error may also occur if you attempt to add a nameserver to a Delegation, but that nameserver already exists for that Delegation, or if you attempt to remove the only nameserver from a Delegation with DS records. Additionally, you will see this error if you attempt to reallocate resources which are not within the parent NET you specify.
413 Response size too large. This may be because of the attachments on a Ticket's messages, for example. The Error Payload returned to you will showthe actual size limit you've reached. Try again with a summary to receive a smaller response.
415 Unsupported Media Type. Ensure that "application/xml" is specified as the mime type.