Skip to main content

Get Static Route (v2.2)

GET 
/v2.2/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/staticroutes/:static_route_id

Get a specific static route.

Request​

Path Parameters

    tenant_id stringrequired

    ID of the tenant.

    site_id stringrequired

    The ID of the site.

    element_id stringrequired

    The ID of the element.

    static_route_id stringrequired

    The ID of the static route.

Responses​

Successful Operation

Schema
    address_family stringrequired

    The static route address family.

    description

    The description of the static route. Max size = 256.

    destination_prefix stringrequired

    The IPv4 or IPv6 address mask for next hop Destination Prefix (IPv4 or IPv6).

    id string

    The ID of the static route.

    name string

    The name of the static route.

    network_context_id string

    The ID of the network context.

    nexthop_reachability_probe boolean

    The Next Hop Reachability Probe is enabled.

    nexthops NextHop[]required

    The details of the next hops configured on the static route.

  • Array [
    • admin_distance integer

    The admin distance for a specific route. The default value for admin distance is 1.

    nexthop_interface_id string

    The next hop interface ID.

    nexthop_ip string

    The next hop IPv4 address.

    self boolean

    Set to True to indicate that traffic is destined for the ION device. By default, Self is set to False.

  • ]
    • scope stringrequired

    Possible values: [GLOBAL, LOCAL]

    The scope of the static route = Local or Global. If scope is local, the device does not advertise the route to other sites and if scope is global, the device advertises the route to other sites.

    tags string[]

    A information field that can be added to identify the static route. Maximum 10 unique tags of length 1024 each are allowed.

Loading...