REST API - get
  1. Operations
  2. appliance
  3. networking
  4. routes

appliance networking routes: get

Get main routing table. A destination of 0.0.0.0 and prefix 0 (for IPv4) or destination of :: and prefix 0 (for IPv6) refers to the default gateway. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

GET https://{server}/rest/appliance/networking/routes
No request parameters

Response:

HTTP Status Code: 200

Representation:

{
    "value" : [
        {
            "mode" : "STATIC",
            "prefix" : 1,
            "destination" : "string",
            "interface_name" : "string",
            "gateway" : "string"
        },
        {
            "mode" : "STATIC",
            "prefix" : 1,
            "destination" : "string",
            "interface_name" : "string",
            "gateway" : "string"
        }
    ]
}

Response Type:

Name Type Description
bold = required
value info[] Routing table.
value[].mode string Static provides information about installation of the route. True indicates the route was installed by the administrator. False indicates the route was autoconfigured. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Mode of the routes static or autoconfigured. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of:
STATIC: Route installed by administrator. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
AUTO: Autoconfigured route. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
value[].destination string Destination address that defines this route. An empty string indicates 0.0.0.0. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional.

value[].prefix long Destination CIDR prefix that defines this route. See http://www.oav.net/mirrors/cidr.html for netmask-to-prefix conversion. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
value[].gateway string Gateway address. An empty string indicates 0.0.0.0. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional.

value[].interface_name string Output device interface, for example, "nic0". An empty string indicates that the rule applies to all interfaces(*). Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional.

Errors:

HTTP Status Code Type Description
500 error Generic error