Get BGP route leak events

Get the BGP route leak events (Beta).

/radar/bgp/leaks/events

get

Radar BGP

radar-get-bgp-route-leak-events

Debug "planAvailability"

{
  "business": true,
  "enterprise": true,
  "free": true,
  "pro": true
}

Debug "tokenPermissions"

{
  "enum": [
    "com.cloudflare.api.user.read"
  ]
}

Debug "parameters"

[
  {
    "in": "query",
    "name": "page",
    "schema": {
      "description": "Current page number, starting from 1",
      "type": "integer"
    }
  },
  {
    "in": "query",
    "name": "per_page",
    "schema": {
      "description": "Number of entries per page",
      "type": "integer"
    }
  },
  {
    "in": "query",
    "name": "eventId",
    "schema": {
      "description": "The unique identifier of a event",
      "type": "integer"
    }
  },
  {
    "in": "query",
    "name": "leakAsn",
    "schema": {
      "description": "The leaking AS of a route leak event",
      "type": "integer"
    }
  },
  {
    "in": "query",
    "name": "involvedAsn",
    "schema": {
      "description": "ASN that is causing or affected by a route leak event",
      "type": "integer"
    }
  },
  {
    "in": "query",
    "name": "involvedCountry",
    "schema": {
      "description": "Country code of a involved ASN in a route leak event",
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "dateRange",
    "schema": {
      "description": "Shorthand date ranges for the last X days - use when you don't need specific start and end dates.",
      "enum": [
        "1d",
        "2d",
        "7d",
        "14d",
        "28d",
        "12w",
        "24w",
        "52w",
        "1dControl",
        "2dControl",
        "7dControl",
        "14dControl",
        "28dControl",
        "12wControl",
        "24wControl"
      ],
      "example": "7d",
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "dateStart",
    "schema": {
      "description": "Start of the date range (inclusive).",
      "example": "2023-09-01T11:41:33.782Z",
      "format": "date-time",
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "dateEnd",
    "schema": {
      "description": "End of the date range (inclusive).",
      "example": "2023-09-01T11:41:33.782Z",
      "format": "date-time",
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "sortBy",
    "schema": {
      "description": "Sort events by field",
      "enum": [
        "ID",
        "LEAKS",
        "PEERS",
        "PREFIXES",
        "ORIGINS",
        "TIME"
      ],
      "example": "TIME",
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "sortOrder",
    "schema": {
      "description": "Sort order",
      "enum": [
        "ASC",
        "DESC"
      ],
      "example": "DESC",
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "format",
    "schema": {
      "description": "Format results are returned in.",
      "enum": [
        "JSON",
        "CSV"
      ],
      "example": "json",
      "type": "string"
    }
  }
]

Debug "requestBody"

null

Debug "responses"

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "properties": {
            "result": {
              "properties": {
                "asn_info": {
                  "items": {
                    "properties": {
                      "asn": {
                        "type": "integer"
                      },
                      "country_code": {
                        "type": "string"
                      },
                      "org_name": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "asn",
                      "org_name",
                      "country_code"
                    ],
                    "type": "object"
                  },
                  "type": "array"
                },
                "events": {
                  "items": {
                    "properties": {
                      "countries": {
                        "items": {
                          "type": "string"
                        },
                        "type": "array"
                      },
                      "detected_ts": {
                        "type": "string"
                      },
                      "finished": {
                        "type": "boolean"
                      },
                      "id": {
                        "type": "integer"
                      },
                      "leak_asn": {
                        "type": "integer"
                      },
                      "leak_count": {
                        "type": "integer"
                      },
                      "leak_seg": {
                        "items": {
                          "type": "integer"
                        },
                        "type": "array"
                      },
                      "leak_type": {
                        "type": "integer"
                      },
                      "max_ts": {
                        "type": "string"
                      },
                      "min_ts": {
                        "type": "string"
                      },
                      "origin_count": {
                        "type": "integer"
                      },
                      "peer_count": {
                        "type": "integer"
                      },
                      "prefix_count": {
                        "type": "integer"
                      }
                    },
                    "required": [
                      "detected_ts",
                      "finished",
                      "id",
                      "leak_asn",
                      "leak_count",
                      "leak_seg",
                      "leak_type",
                      "max_ts",
                      "min_ts",
                      "origin_count",
                      "peer_count",
                      "prefix_count",
                      "countries"
                    ],
                    "type": "object"
                  },
                  "type": "array"
                }
              },
              "required": [
                "asn_info",
                "events"
              ],
              "type": "object"
            },
            "result_info": {
              "properties": {
                "count": {
                  "type": "integer"
                },
                "page": {
                  "type": "integer"
                },
                "per_page": {
                  "type": "integer"
                },
                "total_count": {
                  "type": "integer"
                }
              },
              "required": [
                "count",
                "total_count",
                "page",
                "per_page"
              ],
              "type": "object"
            },
            "success": {
              "example": true,
              "type": "boolean"
            }
          },
          "required": [
            "result",
            "result_info",
            "success"
          ],
          "type": "object"
        }
      }
    },
    "description": "Successful Response"
  },
  "400": {
    "content": {
      "application/json": {
        "schema": {
          "properties": {
            "errors": {
              "items": {
                "properties": {
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "message"
                ],
                "type": "object"
              },
              "type": "array"
            },
            "result": {
              "type": "object"
            },
            "success": {
              "example": false,
              "type": "boolean"
            }
          },
          "required": [
            "result",
            "success",
            "errors"
          ],
          "type": "object"
        }
      }
    },
    "description": "Bad Request"
  }
}

Debug "security"

[
  {
    "api_email": [],
    "api_key": []
  }
]