GET
/api/networksList networks
Lists the networks available to the authenticated user. Use this endpoint to retrieve network identifiers and their names, descriptions, routing peers, resources, routers, and policies.
200Returns an array of network objects containing network identifiers and names, with descriptions, routing peer counts, resources, routers, and policies.
idstringrequired
Network ID
policiesarray<string>required
List of policy IDs associated with the network
resourcesarray<string>required
List of network resource IDs associated with the network
routersarray<string>required
List of router IDs associated with the network
routing_peers_countintegerrequired
Count of routing peers associated with the network
descriptionstringoptional
Network description
namestringrequired
Network name
400Returned when the request is malformed.
401Returned when authentication is required but missing or invalid.
403Returned when the operation is forbidden.
500Returned when an internal server error occurs.
Error handling
A 400 is returned for a malformed request, a 401 when authentication is required but missing or invalid, a 403 when the operation is forbidden, and a 500 for an internal server error.