| API Description | API Path |
|---|---|
List node network routesReturns detailed information about each route in the node routing table. Route information includes the route type (default, static, and so on), a unique route identifier, the route metric, the protocol from which the route was learned, the route source (which is the preferred egress interface), the route destination, and the route scope. The route scope refers to the distance to the destination network: The "host" scope leads to a destination address on the node, such as a loopback address; the "link" scope leads to a destination on the local network; and the "global" scope leads to addresses that are more than one hop away. |
GET /api/v1/cluster/<cluster-node-id>/node/network/routes
GET /api/v1/transport-nodes/<transport-node-id>/node/network/routes GET /api/v1/node/network/routes |
Create node network routeAdd a route to the node routing table. For static routes, the route_type, interface_id, netmask, and destination are required parameters. For default routes, the route_type, gateway address, and interface_id are required. For blackhole routes, the route_type and destination are required. All other parameters are optional. When you add a static route, the scope and route_id are created automatically. When you add a default or blackhole route, the route_id is created automatically. The route_id is read-only, meaning that it cannot be modified. All other properties can be modified by deleting and readding the route. |
POST /api/v1/cluster/<cluster-node-id>/node/network/routes
POST /api/v1/transport-nodes/<transport-node-id>/node/network/routes POST /api/v1/node/network/routes |
Delete node network routeDelete a route from the node routing table. You can modify an existing route by deleting it and then posting the modified version of the route. To verify, remove the route ID from the URI, issue a GET request, and note the absense of the deleted route. |
DELETE /api/v1/node/network/routes/<route-id>
DELETE /api/v1/transport-nodes/<transport-node-id>/node/network/routes/<route-id> DELETE /api/v1/cluster/<cluster-node-id>/node/network/routes/<route-id> |
Read node network routeReturns detailed information about a specified route in the node routing table. |
GET /api/v1/node/network/routes/<route-id>
GET /api/v1/transport-nodes/<transport-node-id>/node/network/routes/<route-id> GET /api/v1/cluster/<cluster-node-id>/node/network/routes/<route-id> |