API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Read existing route-map configuration

Route Maps provide advanced routing policy control by
manipulating route attributes during redistribution between
routing protocols (BGP, OSPF, RIP, static routes). Route
maps use match conditions (IP prefix lists, community lists,
AS path lists) and set actions (metric modification,
next-hop changes, AS path prepending) to filter and transform
routing information. Configure route map sequences with
permit/deny actions to implement complex routing policies for
traffic engineering and route aggregation. Requires
prefix-list, community-list, and AS path-list configurations
for match conditions. Device Limits: Gateway restricts route
map names to 1-50 characters. Use this API to retrieve the
list of route map configurations.

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