Get top prefixes by BGP updates

GET/radar/bgp/top/prefixes

Retrieves the top network prefixes by BGP updates.

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

Query ParametersExpand Collapse

asn: optional array of string

Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.

dateEnd: optional array of string

End of the date range (inclusive).

dateRange: optional array of string

Filters results by date range. For example, use 7d and 7dcontrol to compare this week with the previous week. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).

dateStart: optional array of string

Start of the date range.

format: optional "JSON" or "CSV"

Format in which results will be returned.

One of the following:

"JSON"

"CSV"

limit: optional number

Limits the number of objects returned in the response.

exclusiveMinimum

minimum0

name: optional array of string

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

updateType: optional array of "ANNOUNCEMENT" or "WITHDRAWAL"

Filters results by BGP update type.

One of the following:

"ANNOUNCEMENT"

"WITHDRAWAL"

ReturnsExpand Collapse

result: object { meta, top_0 }

meta: object { dateRange }

dateRange: array of object { endTime, startTime }

endTime: string

Adjusted end of date range.

formatdate-time

startTime: string

Adjusted start of date range.

formatdate-time

top_0: array of object { prefix, value }

prefix: string

value: string

A numeric string.

success: boolean

Get top prefixes by BGP updates

curl https://api.cloudflare.com/client/v4/radar/bgp/top/prefixes \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

{
  "result": {
    "meta": {
      "dateRange": [
        {
          "endTime": "2022-09-17T10:22:57.555Z",
          "startTime": "2022-09-16T10:22:57.555Z"
        }
      ]
    },
    "top_0": [
      {
        "prefix": "2804:77cc:8000::/33",
        "value": "10"
      }
    ]
  },
  "success": true
}

Returns Examples

{
  "result": {
    "meta": {
      "dateRange": [
        {
          "endTime": "2022-09-17T10:22:57.555Z",
          "startTime": "2022-09-16T10:22:57.555Z"
        }
      ]
    },
    "top_0": [
      {
        "prefix": "2804:77cc:8000::/33",
        "value": "10"
      }
    ]
  },
  "success": true
}