Skip to content
Cloudflare API
Start here
API Reference
Radar
BGP
RPKI
Roas

Get RPKI ROA deployment time series

client.radar.bgp.rpki.roas.timeseries(RoaTimeseriesParams { asn, dateEnd, dateStart, 4 more } query?, RequestOptionsoptions?): RoaTimeseriesResponse { meta, serie_0 }
GET/radar/bgp/rpki/roas/timeseries

Retrieves RPKI ROA (Route Origin Authorization) validation ratios over time. Returns the selected metric as a time series. Supports filtering by ASN or location (country code) — multiple values of the same filter type produce one series per value. If no ASN or location is specified, returns the global aggregate.

Security
API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
Accepted Permissions (at least one required)
User Details WriteUser Details Read
ParametersExpand Collapse
query: RoaTimeseriesParams { asn, dateEnd, dateStart, 4 more }
asn?: Array<string>

Filters results by Autonomous System Number. Specify one or more ASNs. Multiple values generate one series per ASN.

dateEnd?: string

End of the date range (inclusive).

formatdate-time
dateStart?: string

Start of the date range (inclusive).

formatdate-time
format?: "JSON" | "CSV"

Format in which results will be returned.

One of the following:
"JSON"
"CSV"
location?: Array<string>

Filters results by location. Specify a comma-separated list of alpha-2 location codes.

metric?: "validPfxsRatio" | "validPfxsV4Ratio" | "validPfxsV6Ratio" | 3 more

Which RPKI ROA validation metric to return. validPfxsRatio = ratio of RPKI-valid prefixes (IPv4+IPv6 combined). validPfxsV4Ratio / validPfxsV6Ratio = same, split by IP version. validIpsRatio = ratio of RPKI-valid address space (IPv4 /24s + IPv6 /48s). validIpsV4Ratio / validIpsV6Ratio = same, split by IP version.

One of the following:
"validPfxsRatio"
"validPfxsV4Ratio"
"validPfxsV6Ratio"
"validIpsRatio"
"validIpsV4Ratio"
"validIpsV6Ratio"
name?: Array<string>

Array of names used to label the series in the response.

ReturnsExpand Collapse
RoaTimeseriesResponse { meta, serie_0 }
meta: Meta { dataTime, queryTime }
dataTime: string

Timestamp of the underlying data.

formatdate-time
queryTime: string

Timestamp when the query was executed.

formatdate-time
serie_0: Serie0 { timestamps, values }
timestamps: Array<string>
values: Array<string>

Get RPKI ROA deployment time series

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const response = await client.radar.bgp.rpki.roas.timeseries();

console.log(response.meta);
{
  "result": {
    "meta": {
      "dataTime": "2019-12-27T18:11:19.117Z",
      "queryTime": "2019-12-27T18:11:19.117Z"
    },
    "serie_0": {
      "timestamps": [
        "2019-12-27T18:11:19.117Z"
      ],
      "values": [
        "10"
      ]
    }
  },
  "success": true
}
Returns Examples
{
  "result": {
    "meta": {
      "dataTime": "2019-12-27T18:11:19.117Z",
      "queryTime": "2019-12-27T18:11:19.117Z"
    },
    "serie_0": {
      "timestamps": [
        "2019-12-27T18:11:19.117Z"
      ],
      "values": [
        "10"
      ]
    }
  },
  "success": true
}