Get BGP route leak events

GET/radar/bgp/leaks/events

Retrieves the BGP route leak events.

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

dateEnd: optional string

End of the date range (inclusive). Alternative to dateRange; provide together with dateStart.

formatdate-time

dateRange: optional string

Filters results by a relative date range ending at the current time. Use <n>d for days (up to 364d) or <n>w for weeks (up to 52w), e.g. 7d. Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window’s length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 3dcontrol covers days -10 to -7, 7dcontrol covers days -14 to -7, 28dcontrol covers days -56 to -28, and 10dcontrol covers days -24 to -14). Mutually exclusive with dateStart/dateEnd.

dateStart: optional string

Start of the date range (inclusive). Alternative to dateRange; provide together with dateEnd.

formatdate-time

eventId: optional number

The unique identifier of a event.

format: optional "JSON" or "CSV"

Format in which results will be returned.

One of the following:

"JSON"

"CSV"

involvedAsn: optional number

ASN that is causing or affected by a route leak event.

involvedCountry: optional string

Country code of a involved ASN in a route leak event.

maxLength2

minLength2

leakAsn: optional number

The leaking AS of a route leak event.

page: optional number

Current page number, starting from 1.

exclusiveMinimum

minimum0

per_page: optional number

Number of entries per page.

exclusiveMinimum

minimum0

sortBy: optional "ID" or "LEAKS" or "PEERS" or 3 more

Sorts results by the specified field.

One of the following:

"ID"

"LEAKS"

"PEERS"

"PREFIXES"

"ORIGINS"

"TIME"

sortOrder: optional "ASC" or "DESC"

Sort order.

One of the following:

"ASC"

"DESC"

ReturnsExpand Collapse

result: object { asn_info, events }

asn_info: array of object { asn, country_code, org_name }

asn: number

country_code: string

org_name: string

events: array of object { id, countries, detected_ts, 10 more }

id: number

countries: array of string

detected_ts: string

finished: boolean

leak_asn: number

leak_count: number

leak_seg: array of number

leak_type: number

max_ts: string

min_ts: string

origin_count: number

peer_count: number

prefix_count: number

result_info: object { count, page, per_page, total_count }

count: number

page: number

per_page: number

total_count: number

success: boolean

Get BGP route leak events

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

{
  "result": {
    "asn_info": [
      {
        "asn": 0,
        "country_code": "country_code",
        "org_name": "org_name"
      }
    ],
    "events": [
      {
        "id": 0,
        "countries": [
          "string"
        ],
        "detected_ts": "detected_ts",
        "finished": true,
        "leak_asn": 0,
        "leak_count": 0,
        "leak_seg": [
          0
        ],
        "leak_type": 0,
        "max_ts": "max_ts",
        "min_ts": "min_ts",
        "origin_count": 0,
        "peer_count": 0,
        "prefix_count": 0
      }
    ]
  },
  "result_info": {
    "count": 0,
    "page": 0,
    "per_page": 0,
    "total_count": 0
  },
  "success": true
}

Returns Examples

{
  "result": {
    "asn_info": [
      {
        "asn": 0,
        "country_code": "country_code",
        "org_name": "org_name"
      }
    ],
    "events": [
      {
        "id": 0,
        "countries": [
          "string"
        ],
        "detected_ts": "detected_ts",
        "finished": true,
        "leak_asn": 0,
        "leak_count": 0,
        "leak_seg": [
          0
        ],
        "leak_type": 0,
        "max_ts": "max_ts",
        "min_ts": "min_ts",
        "origin_count": 0,
        "peer_count": 0,
        "prefix_count": 0
      }
    ]
  },
  "result_info": {
    "count": 0,
    "page": 0,
    "per_page": 0,
    "total_count": 0
  },
  "success": true
}