Get BGP routing table stats

client.Radar.BGP.Routes.Stats(ctx, query) (*BGPRouteStatsResponse, error)

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 BGPRouteStatsParams

ASN param.Field[int64]Optional

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

Format param.Field[BGPRouteStatsParamsFormat]Optional

Format in which results will be returned.

const BGPRouteStatsParamsFormatJson BGPRouteStatsParamsFormat = "JSON"

const BGPRouteStatsParamsFormatCsv BGPRouteStatsParamsFormat = "CSV"

Location param.Field[string]Optional

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

maxLength2

minLength2

ReturnsExpand Collapse

type BGPRouteStatsResponse struct{…}

Meta BGPRouteStatsResponseMeta

DataTime string

QueryTime string

TotalPeers int64

Stats BGPRouteStatsResponseStats

DistinctOrigins int64

DistinctOriginsIPV4 int64

DistinctOriginsIPV6 int64

DistinctPrefixes int64

DistinctPrefixesIPV4 int64

DistinctPrefixesIPV6 int64

RoutesInvalid int64

RoutesInvalidIPV4 int64

RoutesInvalidIPV6 int64

RoutesTotal int64

RoutesTotalIPV4 int64

RoutesTotalIPV6 int64

RoutesUnknown int64

RoutesUnknownIPV4 int64

RoutesUnknownIPV6 int64

RoutesValid int64

RoutesValidIPV4 int64

RoutesValidIPV6 int64

Get BGP routing table stats

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/option"
  "github.com/stainless-sdks/cloudflare-go/radar"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  response, err := client.Radar.BGP.Routes.Stats(context.TODO(), radar.BGPRouteStatsParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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
}