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 with RPSL headers and payloads. 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:

1. 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.
2. 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 ID/Org Handle in the URL; those are noted in this document.
3. Copy the template fields as-is from your templates to the REST payloads; both are in RPSL format.

The following section lists IRR template objects that are supported or unsupported by REST calls.

Template objects supported by REST calls:

• as-set
• aut-num
• route
• route6
• route-set

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

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

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

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

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

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

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

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

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

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