Application Programming Interface (API) Keys

An Application Programming Interface (API) key is a secret code that you can use to identify yourself to ARIN when you interact with us. You create an API key in ARIN Online, and then use the key in interactions with ARIN outside of ARIN Online. Multiple interactions may be performed with the same API key, or you can create multiple API keys to locally track specific requests or to access reports. The API key does not expire, but can be deactivated at any time.

Your API key is used in some interactions with ARIN, including the following uses:

Creating and Managing API Keys

To create an API key:

  1. 1. Log in to your ARIN Online account and select Settings from the menu under your name.
  2. In the Security Info section, from the Actions menu, choose Manage API Keys.
  3. In the Generate API Key section, choose Create API Key. The API key you just created is listed under Active API Keys.

You can associate API keys with an email address, though this is not recommended, because it exposes your ARIN data to the risks associated with MAIL FROM authentication. It is not as secure as submitting your API key when you perform certain actions in ARIN Online.

To deactivate an API key:

  1. Log in to your ARIN Online account and select Settings from the menu under your name.
  2. In the Security Info section, from the Actions menu, choose Manage API Keys.
  3. In the View & Manage API Keys section, under Active API Keys, find the key you want to deactivate and choose Deactivate. If the deactivation is successful, you receive a message and the key is moved to the list of inactive API keys.

Using API Keys

RESTful Calls

ARIN’s RESTful Provisioning system leverages modern application interfaces and provides even stronger authentication. RESTful calls require the use of an API key. In order for your RESTful call to be considered, your ARIN Online account must be linked to a Point of Contact (POC) that has authority to make the request.

Email Templates

ARIN’s Version 5 Templates, released in 2011, use API keys to authenticate your submissions. To use Version 5 Templates, include your API key in the line indicated for it by the template.

Working with Version 4 Templates

ARIN understands that template changes can cause complications for customers with automated systems that were not designed for Version 5 Templates. To provide backward compatibility, ARIN provides two mechanisms by which you can send older Version 4 Templates to ARIN.

Option 1: Use an API Key with Version 4 Templates (recommended workaround)

  • To use Version 4 Templates in conjunction with your API key, place your API key anywhere in the subject line or From: header of your email template requests.
  • If you include an API key, you can use any sender email address that is convenient for you.

OR:

Option 2: Associate email address to an API Key (you assume risk)

If you choose this approach, any Version 4 Templates sent to ARIN with the Associated Email “from:” address will be considered to have been sent by the holder of the associated API key.

  • All email request templates sent from an email address that has been associated with a key are processed. The ease of spoofing the From: header by parties who are attempting to gain control of your resources makes this method less secure than using an API key.
  • If you use this option, associate an email address that is different from your email address displayed in ARIN’s Whois, (i.e., not in your organization’s ARIN POC records).
  • This option makes it unnecessary to include an API key anywhere in the request template.

Caution: Using Option 2 is not as secure as explicitly including the API key in your request submission, especially if the email address you specify is public information (for example, if it is found on POC data within the Whois services of ARIN, other RIRs, or domain registries/registrars).

Report Downloads

Reports are available to authorized users by choosing Downloads and Services in ARIN Online. However, if you have an API key, a RESTful HTTP request containing your API key can be used to automate the retrieval of restricted access reports. This means you do not have to log in to your ARIN Online account to download the report. For more information, visit: