Create Static Route (v2.3)

POST 
/v2.3/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/staticroutes

Create a 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.

application/json

Body

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.

vrf_context_id string

The VRF (Virtual Routing and Forwarding) ID.

Responses

200

Successful Operation

application/json

Schema

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.

vrf_context_id string

The VRF (Virtual Routing and Forwarding) ID.

Example (from schema)

{
  "address_family": "string",
  "destination_prefix": "string",
  "id": "string",
  "name": "string",
  "network_context_id": "string",
  "nexthop_reachability_probe": true,
  "nexthops": [
    {
      "admin_distance": 0,
      "nexthop_interface_id": "string",
      "nexthop_ip": "string",
      "self": true
    }
  ],
  "scope": "GLOBAL",
  "tags": [
    "string"
  ],
  "vrf_context_id": "string"
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "INVALID_JSON_INPUT"
      },
      {
        "code": "INVALID_JSON_EXTRA_ATTRIBUTE"
      },
      {
        "code": "STATICROUTE_CONFIG_INVALID_DEVICE"
      },
      {
        "code": "STATICROUTE_NEXTHOP_REACHABILITY_PROBE_NOT_SUPPORTED"
      },
      {
        "code": "STATICROUTE_CONFIG_INVALID_NEXTHOP_DUPLICATE"
      },
      {
        "code": "STATICROUTE_CONFIG_INVALID_DESTINATIONPREFIX"
      },
      {
        "code": "STATICROUTE_CONFIG_ADDRESS_FAMILY_IPV6_NOT_SUPPORTED"
      },
      {
        "code": "STATICROUTE_CONFIG_INVALID_DESTINATIONPREFIX_IPV6"
      },
      {
        "code": "STATICROUTE_CONFIG_NEXTHOPIP_DIFFERENT_FROM_ADDRESSFAMILY_NOT_SUPPORTED"
      },
      {
        "code": "STATICROUTE_CONFIG_DESTINATIONPREFIX_DIFFERENT_FROM_ADDRESSFAMILY_NOT_SUPPORTED"
      },
      {
        "code": "STATICROUTE_CONFIG_INVALID_NEXTHOPIPV6"
      },
      {
        "code": "STATICROUTE_CONFIG_INVALID_NEXTHOPIP"
      },
      {
        "code": "STATICROUTE_CONFIG_INVALID_NEXTHOP_SELF"
      },
      {
        "code": "STATICROUTE_NEXTHOP_REACHABILITY_PROBE_NOT_APPLICABLE"
      },
      {
        "code": "STATICROUTE_CONFIG_REQUIRED_INTERFACE_FOR_LINK_LOCAL_IPV6"
      },
      {
        "code": "STATICROUTE_CONFIG_INVALID_NEXTHOP"
      },
      {
        "code": "INTERFACE_NOT_FOUND"
      },
      {
        "code": "STATICROUTE_NEXTHOP_CANNOT_SET_NEXTHOP_REACHABILITY_PROBE"
      },
      {
        "code": "INVALID_NETWORK_CONTEXT"
      },
      {
        "code": "PREFIX_EXACT_MATCH_WITH_OTHER_SITE"
      }
    ]
  }
}

Loading...