Converting IRR Email Templates to REST Commands
This page provides an overview of how to convert your IRR-email templates to the corresponding IRR REST commands. The first table for each command shows the email template keywords and the REST call to create or update the object. The second table shows the template fields and corresponding payloads. (These field names are the same for templates and the REST command payloads.)
Basically, you only need to rewrite your scripts or back end software actions to do the following:
- Convert the template email subject header keyword to the appropriate REST call, depending on the action you want to perform (add or update). Note that at this time, only one action (PUT, POST, etc.) is allowed per REST call.
- Configure the REST call to include the required fields in its URL. Your API key is needed in all calls, and the IP address is needed for a
route
object. Some commands require your Org Handle in the URL; those are noted in this document. - Copy the template fields as-is from your templates to the REST payloads; both are in RPSL format.
Some template fields are ignored in the payload, and no action is taken by the REST system for these fields. Those fields are indicated in the tables in this document.
The following section lists IRR template objects that are supported or unsupported by REST calls.
Template objects supported by REST calls:
Template objects not supported by REST calls:
- inet6num
- inetnum
- inet-rtr
- key-cert
- mntner
The following sections give information about template objects and the corresponding REST calls with the objects listed in alphabetical order.
as-set Object Type
The following table lists the email subject header keywords that are used when sending templates and the corresponding REST call.
more information about as-set
objects
Email Subject Header Keyword | REST Call |
---|---|
NEW: | POST https://reg.arin.net/rest/irr/as-set?apikey=APIKEY&orgHandle=HANDLE |
DIFF: | PUT https://reg.arin.net/rest/irr/as-set?apikey=APIKEY&orgHandle=HANDLE |
HELP: / HOWTO: | No corresponding REST call |
The following table lists the email template fields and the corresponding fields in the REST call payload. Fields that are marked as “not supported” or “ignored” will not cause the command to fail, but will cause no action to be taken in the database (for example, notify
will not cause email updates to be sent to the specified email address).
Template Field | REST Call Payload Field | Required/Optional in REST Payload |
---|---|---|
as-set: | as-set: | required |
descr: | descr: | required |
members: | members: | optional |
mbrs-by-ref: | mbrs-by-ref: | optional |
remarks: | remarks: | optional |
tech-c: | tech-c: | required |
admin-c: | admin-c: | required |
notify: | notify: | not supported |
mnt-by: | mnt-by: | required |
mnt-lower: | mnt-lower | optional |
changed: | changed: | ignored |
source: ARIN | source: ARIN | required |
aut-num Object Type
The following table lists the email subject header keywords that are used when sending templates and the corresponding REST call.
more information about aut-num
objects
Email Subject Header Keyword | REST Call |
---|---|
NEW: | POST https://reg.arin.net/rest/irr/aut-num/ASN?apikey=APIKEY |
DIFF: | PUT https://reg.arin.net/rest/irr/aut-num/ASN?apikey=APIKEY |
HELP: / HOWTO: | No corresponding REST call |
The following table lists the email template fields and the corresponding fields in the REST call payload. Fields that are marked as “not supported” or “ignored” will not cause the command to fail, but will cause no action to be taken in the database (for example, notify
will not cause email updates to be sent to the specified email address).
Template Field | REST Call Payload Field | Required/Optional in REST Payload |
---|---|---|
aut-num: | aut-num | required |
as-name: | as-name: | required |
descr: | descr: | required |
member-of: | member-of: | optional |
import: | import: | optional |
mp-import: | mp-import | optional |
export: | export: | optional |
mp-export: | mp-export: | optional |
default: | default: | optional |
mp-default: | mp-default: | optional |
remarks: | remarks: | optional |
admin-c: | admin-c: | required |
tech-c: | tech-c: | required |
notify: | notify: | not supported |
mnt-lower: | mnt-lower: | optional |
mnt-by: | mnt-by: | required |
changed: | changed: | ignored |
source: ARIN | source: ARIN | required |
route Object Type
The following table lists the email subject header keywords that are used when sending templates and the corresponding REST call.
more information about route
objects
Email Subject Header Keyword | REST Call |
---|---|
NEW: | POST https://reg.arin.net/rest/irr/route/IPAddress/prefixLength/originAS?apikey=APIKEY |
DIFF: | PUT https://reg.arin.net/rest/irr/route/IPAddress/prefixLength/originAS?apikey=APIKEY |
HELP: / HOWTO: | No corresponding REST call |
The following table lists the email template fields and the corresponding fields in the REST call payload. Fields that are marked as “not supported” or “ignored” will not cause the command to fail, but will cause no action to be taken in the database (for example, notify
will not cause email updates to be sent to the specified email address).
Template Field | REST Call Payload Field | Required/Optional in REST Payload |
---|---|---|
route: | route: | required |
descr: | descr: | required |
origin: | origin: | required |
holes: | holes: | optional |
member-of: | member-of: | optional |
inject: | inject: | optional |
aggr-mtd: | aggr-mtd: | optional |
aggr-bndry: | aggr-bndry: | optional |
export-comps: | export-comps: | optional |
components: | components: | optional |
remarks: | remarks: | optional |
tech-c: | tech-c: | required |
admin-c: | admin-c: | required |
notify: | notify: | not supported |
mnt-lower: | mnt-lower: | optional |
mnt-by: | mnt-by: | required |
changed: | changed: | ignored |
source: ARIN | source: ARIN | required |
route6 Object Type
The following table lists the email subject header keywords that are used when sending templates and the corresponding REST call.
more information about route6
objects
Email Subject Header Keyword | REST Call |
---|---|
NEW: | POST https://reg.arin.net/rest/irr/route/IPAddress/prefixLength/originAS?apikey=APIKEY |
DIFF: | PUT https://reg.arin.net/rest/irr/route/IPAddress/prefixLength/originAS?apikey=APIKEY |
HELP: / HOWTO: | No corresponding REST call |
The following table lists the email template fields and the corresponding fields in the REST call payload. Fields that are marked as “not supported” or “ignored” will not cause the command to fail, but will cause no action to be taken in the database (for example, notify
will not cause email updates to be sent to the specified email address).
Template Field | REST Call Payload Field | Required/Optional in REST Payload |
---|---|---|
route6: | route6: | required |
descr: | descr: | required |
origin: | origin: | required |
holes: | holes: | optional |
member-of: | member-of: | optional |
inject: | inject: | optional |
aggr-mtd: | aggr-mtd: | optional |
aggr-bndry: | aggr-bndry: | optional |
export-comps: | export-comps: | optional |
components: | components: | optional |
remarks: | remarks: | optional |
tech-c: | tech-c: | required |
admin-c: | admin-c: | required |
notify: | notify: | not supported |
mnt-lower: | mnt-lower | optional |
mnt-by: | mnt-by: | required |
changed: | changed: | ignored |
source: ARIN | source: ARIN | required |
route-set Object Type
The following table lists the email subject header keywords that are used when sending templates and the corresponding REST call.
more information about route-set
objects
Email Subject Header Keyword | REST Call |
---|---|
NEW: | POST https://reg.arin.net/rest/irr/route-set?apikey=APIKEY&orgHandle=HANDLE |
DIFF: | PUT https://reg.arin.net/rest/irr/route-set?apikey=APIKEY&orgHandle=HANDLE |
HELP: / HOWTO: | No corresponding REST call |
The following table lists the email template fields and the corresponding fields in the REST call payload. Fields that are marked as “not supported” or “ignored” will not cause the command to fail, but will cause no action to be taken in the database (for example, notify
will not cause email updates to be sent to the specified email address).
Template Field | REST Call Payload Field | Required/Optional in REST Payload |
---|---|---|
route-set: | route-set: | required |
descr: | descr: | required |
members: | members: | optional |
mp-members: | mp-members: | optional |
mbrs-by-ref: | mbrs-by-ref | optional |
remarks: | remarks: | optional |
tech-c: | tech-c: | required |
admin-c: | admin-c: | required |
notify: | notify: | not supported |
mnt-by: | mnt-by: | required |
changed: | changed: | ignored |
source: ARIN | source: ARIN | required |
Internet Routing Registry (IRR)
- IRR Overview
- ARIN IRR User Guide
- Implementation Notes for ARIN's Web-Based IRR
- Automating Your Workflow Using the IRR RESTful API
- Converting IRR Email Templates to REST Commands
- ARIN IRR-email System
- ARIN IRR-email Object Templates
- Internet Routing Registry FAQ
Registration Services Help Desk
7:00 AM to 7:00 PM ET
Phone: +1.703.227.0660
Fax: +1.703.997.8844