-
API service for OpenBMPMore information: http://www.openbmp.orgContact Info: tim@openbmp.orgVersion: 0.1.0BasePath:/v1Eclipse Public License v1.0http://www.eclipse.org/legal/epl-v10.htmlAPI service for OpenBMPMore information: http://www.openbmp.orgContact Info: tim@openbmp.orgVersion: 0.1.0BasePath:/v1Eclipse Public License v1.0http://www.eclipse.org/legal/epl-v10.htmlList count of BGP peers by stateLists number of BGP peers by peer state as reported by the BMP router. It takes BMP router and collector state into account.Consumes:
application/json
Produces:application/json
Query parameters
Name:PeerType (optional)Type:StringEnum:Ipv4, Ipv6, BgpLu, BgpLs, Vpnv4, Evpn, AddPathDescription:BGP peer type derived from peer Capabilities advertisementName:StateOfDataFeed (optional)Type:StringEnum:PeerUp, PeerDown, BmpRouterConnected, BmpRouterNotConnected, CollectorConnected, CollectorNotConnectedDescription:State of the object in terms of data feed. Most relevant state is indicatedName:SortOrder (optional)Type:StringEnum:Asc, DescDescription:Sort order ascending or descendingName:WithGeo (optional)Type:BooleanValue:true, falseDescription:Indicates if geo-coding information should be included or not in responseResponses
200 Returns the count of BGP peers by state Data for Responses Close or press ESC
0 Unexpected error Data for Responses Close or press ESC
Example data
Content-Type: application/json { "Down" : 1.3579000000000001069366817318950779736042022705078125, "PossiblyUp" : 1.3579000000000001069366817318950779736042022705078125, "Up" : 1.3579000000000001069366817318950779736042022705078125, "PossiblyDown" : 1.3579000000000001069366817318950779736042022705078125 }
List all peersLists all BGP peers monitored by all BMP routersConsumes:application/json
Produces:application/json
Query parameters
Name:PeerType (optional)Type:StringEnum:Ipv4, Ipv6, BgpLu, BgpLs, Vpnv4, Evpn, AddPathDescription:BGP peer type derived from peer Capabilities advertisementName:SortByField (optional)Type:StringEnum:Name, Local_IPAddress, LastModifiedDescription:Sort by fieldName:StateOfDataFeed (optional)Type:StringEnum:PeerUp, PeerDown, BmpRouterConnected, BmpRouterNotConnected, CollectorConnected, CollectorNotConnectedDescription:State of the object in terms of data feed. Most relevant state is indicatedName:SortOrder (optional)Type:StringEnum:Asc, DescDescription:Sort order ascending or descendingName:WithGeo (optional)Type:BooleanValue:true, falseDescription:Indicates if geo-coding information should be included or not in responseResponses
200 Returns a list of BGP peers in JSON format array [ Data for Responses Close or press ESC
0 Unexpected error array [ Data for Responses Close or press ESC
Example data
Content-Type: application/json [ "" ]
List peer by local addressLists the BGP peer connected to the specified {IpAddress} on the BMP Router. From BMP router's point of view, this is considered to be the local peering address.Consumes:application/json
Produces:application/json
Path parameters
IpAddress (required) IP address in printed formatQuery parameters
Name:WithGeo (optional)Type:BooleanValue:true, falseDescription:Indicates if geo-coding information should be included or not in responseResponses
200 Returns the peer object matching the local peering IP address Data for Responses Close or press ESC
0 Unexpected error Data for Responses Close or press ESC
Example data
Content-Type: application/json ""
List peer by remote addressLists the BGP peer with the specified {IpAddress}. From BMP router's point of view, this is considered to be the remote peering address.Consumes:application/json
Produces:application/json
Path parameters
IpAddress (required) IP address in printed formatQuery parameters
Name:WithGeo (optional)Type:BooleanValue:true, falseDescription:Indicates if geo-coding information should be included or not in responseResponses
200 Returns the peer object matching the remote peering IP address Data for Responses Close or press ESC
0 Unexpected error Data for Responses Close or press ESC
Example data
Content-Type: application/json ""
List peers by BMP router IPLists all BGP peers monitored by the specified BMP router {IpAddress}.Consumes:application/json
Produces:application/json
Path parameters
IpAddress (required) IP address in printed formatQuery parameters
Name:WithGeo (optional)Type:BooleanValue:true, falseDescription:Indicates if geo-coding information should be included or not in responseResponses
200 Returns the peer object matching BMP router IP address Data for Responses Close or press ESC
0 Unexpected error Data for Responses Close or press ESC
Example data
Content-Type: application/json ""
List peers by typeLists BGP peers which advertised the Capabilities matching the specified {PeerType} (Ipv4, Ipv6, BgpLu, etc.)Consumes:application/json
Produces:application/json
Path parameters
PeerType (required) BGP peer type derived from capabilitiesQuery parameters
Name:WithGeo (optional)Type:BooleanValue:true, falseDescription:Indicates if geo-coding information should be included or not in responseName:StateOfDataFeed (optional)Type:StringEnum:PeerUp, PeerDown, BmpRouterConnected, BmpRouterNotConnected, CollectorConnected, CollectorNotConnectedDescription:State of the object in terms of data feed. Most relevant state is indicatedResponses
200 Returns list of BGP peers by peer type Data for Responses Close or press ESC
0 Unexpected error Data for Responses Close or press ESC
Example data
Content-Type: application/json ""
Get count of routers by connection stateCounts BMP routers by connection state to the collectorConsumes:application/json
Produces:application/json
Responses
200 Returns the count of BMP routers by connection state Data for Responses Close or press ESC
0 Unexpected error Data for Responses Close or press ESC
Example data
Content-Type: application/json { "Connected" : "", "NotConnected" : "" }
Get BMP routersLists all BMP routersConsumes:application/json
Produces:application/json
Query parameters
Name:SortByField (optional)Type:StringEnum:Name, Local_IPAddress, LastModifiedDescription:Sort by fieldName:SortOrder (optional)Type:StringEnum:Asc, DescDescription:Sort order ascending or descendingName:WithGeo (optional)Type:BooleanValue:true, falseDescription:Indicates if geo-coding information should be included or not in responseResponses
200 Returns a list of BMP routers in JSON format array [ Data for Responses Close or press ESC
0 Unexpected error array [ Data for Responses Close or press ESC
Example data
Content-Type: application/json [ "" ]
Get router by IP addressLists BMP router matching the IP addressConsumes:application/json
Produces:application/json
Path parameters
IpAddress (required) IP address in printed formatQuery parameters
Name:WithGeo (optional)Type:BooleanValue:true, falseDescription:Indicates if geo-coding information should be included or not in responseResponses
200 Returns the BMP router object matching the IP address Data for Responses Close or press ESC
0 Unexpected error Data for Responses Close or press ESC
Example data
Content-Type: application/json ""
Get BMP routers in the Connected stateLists all BMP routers in the Connected to collector stateConsumes:application/json
Produces:application/json
Query parameters
Name:SortByField (optional)Type:StringEnum:Name, Local_IPAddress, LastModifiedDescription:Sort by fieldName:SortOrder (optional)Type:StringEnum:Asc, DescDescription:Sort order ascending or descendingName:WithGeo (optional)Type:BooleanValue:true, falseDescription:Indicates if geo-coding information should be included or not in responseResponses
200 Returns a list of BMP routers in JSON format array [ Data for Responses Close or press ESC
0 Unexpected error array [ Data for Responses Close or press ESC
Example data
Content-Type: application/json [ "" ]
Get BMP routers in the NotConnected stateLists all BMP routers in the NotConnected to collector stateConsumes:application/json
Produces:application/json
Query parameters
Name:SortByField (optional)Type:StringEnum:Name, Local_IPAddress, LastModifiedDescription:Sort by fieldName:SortOrder (optional)Type:StringEnum:Asc, DescDescription:Sort order ascending or descendingName:WithGeo (optional)Type:BooleanValue:true, falseDescription:Indicates if geo-coding information should be included or not in responseResponses
200 Returns a list of BMP routers in JSON format array [ Data for Responses Close or press ESC
0 Unexpected error array [ Data for Responses Close or press ESC
Example data
Content-Type: application/json [ "" ]
List PrefixesLists all active prefixes received from all peersConsumes:application/json
Produces:application/json
Query parameters
Name:SortByField (optional)Type:StringEnum:Name, Local_IPAddress, LastModifiedDescription:Sort by fieldName:StateOfDataFeed (optional)Type:StringEnum:PeerUp, PeerDown, BmpRouterConnected, BmpRouterNotConnected, CollectorConnected, CollectorNotConnectedDescription:State of the object in terms of data feed. Most relevant state is indicatedName:SortOrder (optional)Type:StringEnum:Asc, DescDescription:Sort order ascending or descendingName:WithGeo (optional)Type:BooleanValue:true, falseDescription:Indicates if geo-coding information should be included or not in responseResponses
200 Returns a list of prefixes in JSON format array [ Data for Responses Close or press ESC
0 Unexpected error array [ Data for Responses Close or press ESC
Example data
Content-Type: application/json [ "" ]
List Prefixes by BMP Router IPLists all prefixes monitored by the mathcing BMP router IP addressConsumes:application/json
Produces:application/json
Path parameters
IpAddress (required) IP address in printed formatQuery parameters
Name:WithGeo (optional)Type:BooleanValue:true, falseDescription:Indicates if geo-coding information should be included or not in responseResponses
200 Returns a list of prefixes monitored by BMP router IP array [ Data for Responses Close or press ESC
0 Unexpected error array [ Data for Responses Close or press ESC
Example data
Content-Type: application/json [ "" ]