API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Read existing BGP router configuration

Border Gateway Protocol (BGP) is the standard exterior gateway
protocol (RFC 4271) for exchanging routing information between
autonomous systems on the Internet and enterprise networks. BGP
supports IPv4/IPv6 unicast, EVPN (Ethernet VPN), and multicast
address families with advanced features including route reflection,
confederation, graceful restart, and multi-path load balancing.
Configure BGP global parameters, neighbor relationships, route
redistribution, and address family-specific policies. Requires route
map, prefix list, keychain, and community list configurations for
routing policy enforcement. Use this API to retrieve BGP
configuration.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

LIBRARY - Returns shared objects in library. For LIBRARY, all other parameters listed below, except 'detailed' , will be ignored. LOCAL - Returns configurations for a scope and one or more device function based on parameters below.

string

Retrieves LOCAL or SHARED or both(default) configuration objects.

string

Configuration at a given scope. Mandatory for view-type = LOCAL.

string

Filters configuration specific to given device-function type. If not provided and view_type = LOCAL, then defaults to all device-function's.

boolean

True - Returns effective configuration (i.e hierarchically merged configuration). False - Returns committed configuration at a given scope.

boolean

True - Includes annotations in the returned json to indicate the type of object, scope, and device function. False - Returns only config objects without annotations.

integer

Limit for pagination.

integer

Offset for pagination.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json