BGP summary
These existing reads are included in the 1.4.4 OpenAPI reference. Ordinary authenticated operator, engineer and admin credentials are supported. Restricted read-only API keys receive 403; documentation inclusion does not change access.
GET /api/v1/bgp/summary
Aggregate BGP statistics for an autonomous system: peer counts by state and unique prefix totals by address family. prefixes_ipv4/prefixes_ipv6 count DISTINCT prefix across the AS's best-path table, so a prefix advertised by several route reflectors counts once (unlike the per-target received-path counts in the BMP sync/stats events, which sum across peers).
Auth: all authenticated roles
Query params:
| Param |
Type |
Required |
Description |
as_id |
UUID |
Yes |
Autonomous system to summarize |
Response: 200 OK
{
"peer_count": 12,
"peers_up": 10,
"peers_down": 2,
"prefixes_ipv4": 850000,
"prefixes_ipv6": 200000
}
Errors: 400 if as_id is missing.