GET
/api/networks/{networkId}/routers/{routerId}Retrieve a network router
Retrieves a router from a specified network. Use networkId and routerId to identify the network and router to retrieve. The response includes the router's metric, enabled status, and masquerade setting.
networkIdstringrequired
The unique identifier of the network containing the router.
routerIdstringrequired
The unique identifier of the router to retrieve.
200Returns the router object, including its identifier, metric, masquerade and enabled settings, and any associated peer or peer groups.
idstringrequired
Network Router Id
enabledbooleanrequired
Network router status
masqueradebooleanrequired
Indicate if peer should masquerade traffic to this route's prefix
metricintegerrequired
Route metric number. Lowest number has higher priority
peerstringoptional
Peer Identifier associated with route. This property can not be set together with `peer_groups`
peer_groupsarray<string>optional
Peers Group Identifier associated with route. This property can not be set together with `peer`
400Returned when the request is invalid.
401Returned when the request lacks valid authentication.
403Returned when the authenticated user is not permitted to retrieve the router.
500Returned when an internal server error occurs.
Error handling
A 400 indicates an invalid request; a 401 indicates missing or invalid authentication; a 403 indicates insufficient permission; and a 500 indicates an internal server error. The networkId path parameter must identify the network, and the routerId path parameter must identify the router to retrieve.