HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

/system/vrfs/{VRF.name}/ospf_routers/{OSPF_Router.instance_tag}/ospf_routes/{OSPF_Route.route_type},{OSPF_Route.prefix},{OSPF_Route.path},{OSPF_Route.ospf_area}

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

Reference Resource: VRF
VRF identifier. Should be alphanumeric. VRF names must be unique.

string
required

Reference Resource: OSPF_Router
The list of all the OSPFv2 Router instances.

string
enum
required

Reference Resource: OSPF_Route
Specifies the the type of the route. route_to_abr -> Specifies that this is a route to an Area Border Router route_to_asbr -> Specifies that this is a route to an Autonomous System Border Router route_to_abr_asbr -> Specifies that this is a route to an Area Border Router and Autonomous System Border Router route_to_prefix -> Specifies any route to a network.

Allowed:
string
required

Reference Resource: OSPF_Route
Specifies the prefix address in A.B.C.D/M format or border router-id in A.B.C.D format.

string
required

Reference Resource: OSPF_Route
The nexthop of the route. For example x.x.x.x/ifName (or) directly attached to ifName.

string
required

Reference Resource: OSPF_Route
OSPF Area to which the route belongs.

Query Params
attributes
array of strings

Columns to display.

attributes
integer

Depth to traverse.

string
enum

Select configuration, status and/or statistics. Default is all categories.

Allowed:
filter
array of strings

Filter rows by attribute values. Format: attribute:value

filter
string
enum

Count the number of rows found.

Allowed:
Headers
string

Entity-tag value for representation comparison (see RFC 7232 - Conditional Requests - section 3.2)

Responses

304

Not Modified

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

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