PUT
/api/networks/{networkId}Replace a network configuration
Replaces the configuration of the network identified by its network ID. Include the required name field in the request body and optionally provide a description. The response contains the updated network object.
networkIdstringrequired
The unique identifier of the network to replace.
Replacement network details; the name field is required.
descriptionstringoptional
Network description
namestringrequired
Network name
200Returns the updated network object, including its identifier, name, and available network details.
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 or the required `name` field is missing.
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 to replace, and the request body must include name.