ARIN RPKI RESTful API User Guide

Introduction

In the Resource Public Key Infrastructure (RPKI), a Route Origin Authorization (ROA) is an attestation that the holder of a set of prefixes has authorized an Autonomous System to originate routes for those prefixes. An Autonomous System Provider Authorization (ASPA) is a cryptographically signed object made by the authorized resource holder that allows holders of Autonomous System (AS) identifiers in their capacity as customers to authorize other ASes as their providers.

You can use ARIN’s Representational State Transfer (REST) commands to create, delete, and list your ROAs and ASPAs.

Full details on ARIN’s RESTful endpoints can be found here.

Create, Modify and Delete ROAs

This is a unified call for creating, modifying, and deleting ROAs. This operation can be performed in a single transaction combined with the “Create, Modify, and Delete ASPAs” operation, meaning that they will all succeed or fail together.

ARIN will automatically renew all ROAs created with this service.

If Reg-RWS returns an error code and/or Error Payload to you when performing this call, refer to this list of error codes.

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.

Payload

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

Get a List of ROAs for an Org

This call returns a list of ROAs for the Org specified in your URL, with a ROA Spec Payload included for each ROA. The ROA Spec Payload contains information about an individual ROA such as ASNs, IP addresses, and valid dates.

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.
• autoRenewed: Boolean specifying whether ARIN will automatically renew the ROA.
• autoLinked: Identifies true or false, the existance of a linked IRR object.

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>

Create, Modify, and Delete ASPAs

This is a unified call for creating, modifying, and deleting ASPAs. This operation can be performed in a single transaction combined with the “Create, Modify and Delete ROAs” operation, meaning that they will all succeed or fail together.

ARIN will automatically renew all ASPAs created with this service.

If Reg-RWS returns an error code and/or Error Payload to you when performing this call, refer to this list of error codes.

The RPKI Transaction Payload describes ASPAs to be deleted and ASPAs to be created.

Payload

<rpkiTransaction>
  <aspaDelete>
    <customerAsId></customerAsId>
    <customerAsId></customerAsId>
  </aspaDelete>
  <aspaAdd>
    <aspa>
      <customerAsId></customerAsId>
      <providerAsIds>
        <providerAsId></providerAsId>
        <providerAsId></providerAsId>
      </providerAsIds>
    </aspa>
  </aspaAdd>
</rpkiTransaction>

Example

<rpkiTransaction>
  <aspaDelete>
    <customerAsId>64496</customerAsId>
    <customerAsId>644967</customerAsId>
  </aspaDelete>
  <aspaAdd>
    <aspa>
      <customerAsId>64496</customerAsId>
      <providerAsIds>
        <providerAsId>64497</providerAsId>
        <providerAsId>64498</providerAsId>
      </providerAsIds>
    </aspa>
  </aspaAdd>
</rpkiTransaction>

Get a List of ASPAs for an Org

This call returns a list of ASPAs for the Org specified in your URL, with an ASPA Spec Payload included for each ASPA. The ASPA Spec Payload contains information about an individual ASPA such as customer and provider ASNs.

The ASPA Spec Payload provides information about ASPAs, including:

• customerAsId: An AS registered to the customer.
• providerAsIds: A list of provider ASes.

Payload

<aspa>
  <customerAsId></customerAsId>
  <providerAsIds>
    <providerAsId></providerAsId>
    <providerAsId></providerAsId>
  </providerAsIds>
</aspa>

Example

<aspa>
  <customerAsId>64496</customerAsId>
  <providerAsIds>
    <providerAsId>64497</providerAsId>
    <providerAsId>64498</providerAsId>
  </providerAsIds>
</aspa>