Get BGP routing table stats

client.radar.bgp.routes.stats(?, ?): RouteStatsResponse { meta, stats }

GET/radar/bgp/routes/stats

Retrieves the BGP routing table stats.

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: RouteStatsParams { asn, format, location }

asn?: number

Filters results by Autonomous System. Specify a single Autonomous System Number (ASN) as integer.

format?: "JSON" | "CSV"

Format in which results will be returned.

One of the following:

"JSON"

"CSV"

location?: string

Filters results by location. Specify an alpha-2 location code.

maxLength2

minLength2

ReturnsExpand Collapse

RouteStatsResponse { meta, stats }

meta: Meta { data_time, query_time, total_peers }

data_time: string

query_time: string

total_peers: number

stats: Stats { distinct_origins, distinct_origins_ipv4, distinct_origins_ipv6, 15 more }

distinct_origins: number

distinct_origins_ipv4: number

distinct_origins_ipv6: number

distinct_prefixes: number

distinct_prefixes_ipv4: number

distinct_prefixes_ipv6: number

routes_invalid: number

routes_invalid_ipv4: number

routes_invalid_ipv6: number

routes_total: number

routes_total_ipv4: number

routes_total_ipv6: number

routes_unknown: number

routes_unknown_ipv4: number

routes_unknown_ipv6: number

routes_valid: number

routes_valid_ipv4: number

routes_valid_ipv6: number

Get BGP routing table stats

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.routes.stats();

console.log(response.meta);

{
  "result": {
    "meta": {
      "data_time": "data_time",
      "query_time": "query_time",
      "total_peers": 0
    },
    "stats": {
      "distinct_origins": 0,
      "distinct_origins_ipv4": 0,
      "distinct_origins_ipv6": 0,
      "distinct_prefixes": 0,
      "distinct_prefixes_ipv4": 0,
      "distinct_prefixes_ipv6": 0,
      "routes_invalid": 0,
      "routes_invalid_ipv4": 0,
      "routes_invalid_ipv6": 0,
      "routes_total": 0,
      "routes_total_ipv4": 0,
      "routes_total_ipv6": 0,
      "routes_unknown": 0,
      "routes_unknown_ipv4": 0,
      "routes_unknown_ipv6": 0,
      "routes_valid": 0,
      "routes_valid_ipv4": 0,
      "routes_valid_ipv6": 0
    }
  },
  "success": true
}

Returns Examples

{
  "result": {
    "meta": {
      "data_time": "data_time",
      "query_time": "query_time",
      "total_peers": 0
    },
    "stats": {
      "distinct_origins": 0,
      "distinct_origins_ipv4": 0,
      "distinct_origins_ipv6": 0,
      "distinct_prefixes": 0,
      "distinct_prefixes_ipv4": 0,
      "distinct_prefixes_ipv6": 0,
      "routes_invalid": 0,
      "routes_invalid_ipv4": 0,
      "routes_invalid_ipv6": 0,
      "routes_total": 0,
      "routes_total_ipv4": 0,
      "routes_total_ipv6": 0,
      "routes_unknown": 0,
      "routes_unknown_ipv4": 0,
      "routes_unknown_ipv6": 0,
      "routes_valid": 0,
      "routes_valid_ipv4": 0,
      "routes_valid_ipv6": 0
    }
  },
  "success": true
}