HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

/system/vrfs/{name}/static_routes/{prefix}/static_nexthops

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: Static_Route
IPv4 or IPv6 destination prefix and mask in the address/mask format. Example 192.168.0.0/16

Body Params
int64
1 to 4294967295

Route tag to be used to filter routes and apply administrative policies, such as redistribution with route maps.

string
length ≤ 45

IP address of the nexthop device.

integer
1 to 255

Administrative distance to be used instead of the default.

string
enum

Nexthop corresponding to the static route is 'forward', 'blackhole' or 'reject'. forward - Packets to destinations that match this route will be forwarded based on the nexthop entry. reject - Packets to destinations that match this route will be discarded and corresponding ICMP unreachable messages sent to the sender. blackhole - Packets to destinations that match this route will be silently discarded.

Allowed:
boolean

Enables BFD session to the specific next hop.

integer
required

Reference Resource: Static_Nexthop
Nexthops of the static route indexed by an unique identifier. Should be empty in case of Blackhole or Reject.

string

Reference Resource: Port
Egress port, if specified.

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Language
LoadingLoading…