HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

/system/vrfs/{VRF.name}/bgp_routes/{BGP_Route.prefix},{BGP_Route.peer},{BGP_Route.vni},{BGP_Route.path_id}/vpnv4_routes

Path Params
string
required

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

string
required

Reference Resource: BGP_Route
IPv4, IPv6 or EVPN destination prefix. Examples: IPv4 Prefix - 192.168.0.0/16 IPv6 Prefix - 2002::2/64 EVPN Type 1 Prefix - 100:1-[1]:[0]:[0000.0000.0010.0000] EVPN Type 2 Prefix - 100:1-[2]:[0]:[0]:[48]:[0006.f63f.e3c1]:[32]:[172.16.30.33] EVPN Type 3 Prefix - 2.2.2.2:10-[3]:[0]:[32]:[10.1.1.1] EVPN Type 4 Prefix - 100:1-[4]:[0000.0000.0010.0000]:[10.1.1.1] EVPN Type 5 prefix - 100:1-[5]:[0]:[0]:[24]:[10.10.10.0]

string
required

Reference Resource: BGP_Route

string
required

Reference Resource: BGP_Route
Specifies Virtual Network Identifier. This is specific to EVPN routes and will be -1 for all non-EVPN routes.

string
required

Reference Resource: BGP_Route
Path ID associated with this prefix. If the peer does not send a path ID, the path ID will be set to 0.

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
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json