GET
/api/networks/{networkId}Retrieve a network
Retrieves the network object identified by its network ID. Use networkId to select the network whose details you need. The response includes the network identifier, name, and associated network details.
networkIdstringrequired
The unique identifier of the network to retrieve.
200Returns a network object containing its identifier, name, and associated resources, routers, routing peer count, 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. The networkId path parameter must identify the network you want to retrieve.