GET
/api/networks/routersList network routers
Lists network routers. Use this endpoint to retrieve the available router objects without specifying a network in the request. Each result includes router settings such as its metric, enabled status, and masquerade setting.
200Returns an array of router objects, each 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 list routers.
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. Send valid credentials in the Authorization header to authenticate the request.