Synthetic Devices
Model a network’s internet connections, intranets, L2VPNs, L3VPNs, WAN circuits, and encryptors.OpenAPI: YAML | JSON
The Forward Platform models network connectivity between customer edge devices via user-defined synthetic devices. These include an internet node, intranet nodes, L2 VPNs, L3 VPNs, WAN circuits, and encryptors.
The resources in this section are for defining, updating, and retrieving a network’s synthetic devices. Changes to a network’s synthetic devices affect future Snapshots.
Get a network's encryptors
/api/networks/:networkId/encryptors
Replace all of a network’s encryptors
/api/networks/:networkId/encryptors
Get an encryptor
/api/networks/:networkId/encryptors/:deviceName
Add or replace an encryptor
/api/networks/:networkId/encryptors/:deviceName
Update an encryptor
/api/networks/:networkId/encryptors/:deviceName
Remove an encryptor
/api/networks/:networkId/encryptors/:deviceName
Get the network’s internet node
/api/networks/:networkId/internet-node
Replace the network’s internet node
/api/networks/:networkId/internet-node
Update the network’s internet node
/api/networks/:networkId/internet-node
Get the internet node’s connections
/api/networks/:networkId/internet-node/connections
Add a connection to the internet node
/api/networks/:networkId/internet-node/connections
Remove internet node connections
/api/networks/:networkId/internet-node/connections
Get a network’s intranet nodes
/api/networks/:networkId/intranet-nodes
Replace all of a network’s intranet nodes
/api/networks/:networkId/intranet-nodes
Get an intranet node
/api/networks/:networkId/intranet-nodes/:nodeName
Add or replace an intranet node
/api/networks/:networkId/intranet-nodes/:nodeName
Update an intranet node
/api/networks/:networkId/intranet-nodes/:nodeName
Remove an intranet node
/api/networks/:networkId/intranet-nodes/:nodeName
Get an intranet node’s connections
/api/networks/:networkId/intranet-nodes/:nodeName/connections
Add a connection to an intranet node
/api/networks/:networkId/intranet-nodes/:nodeName/connections
Remove an intranet node’s connections
/api/networks/:networkId/intranet-nodes/:nodeName/connections
Get a network’s L2VPNs
/api/networks/:networkId/l2-vpns
Replace all of a network’s L2VPNs
/api/networks/:networkId/l2-vpns
Get an L2VPN
/api/networks/:networkId/l2-vpns/:l2VpnName
Add or replace an L2VPN
/api/networks/:networkId/l2-vpns/:l2VpnName
Update an L2VPN
/api/networks/:networkId/l2-vpns/:l2VpnName
Remove an L2VPN
/api/networks/:networkId/l2-vpns/:l2VpnName
Get an L2VPN’s connections
/api/networks/:networkId/l2-vpns/:l2VpnName/connections
Add a connection to an L2VPN
/api/networks/:networkId/l2-vpns/:l2VpnName/connections
Remove an L2VPN’s connections
/api/networks/:networkId/l2-vpns/:l2VpnName/connections
Get a network’s L3VPNs
/api/networks/:networkId/l3-vpns
Replace all of a network’s L3VPNs
/api/networks/:networkId/l3-vpns
Get an L3VPN
/api/networks/:networkId/l3-vpns/:l3VpnName
Add or replace an L3VPN
/api/networks/:networkId/l3-vpns/:l3VpnName
Update an L3VPN
/api/networks/:networkId/l3-vpns/:l3VpnName
Remove an L3VPN
/api/networks/:networkId/l3-vpns/:l3VpnName
Get an L3VPN’s connections
/api/networks/:networkId/l3-vpns/:l3VpnName/connections
Add a connection to an L3VPN
/api/networks/:networkId/l3-vpns/:l3VpnName/connections
Remove an L3VPN’s connections
/api/networks/:networkId/l3-vpns/:l3VpnName/connections
Get a network’s WAN circuits
/api/networks/:networkId/wan-circuits
Replace all of a network’s WAN circuits
/api/networks/:networkId/wan-circuits
Get a WAN circuit
/api/networks/:networkId/wan-circuits/:wanCircuitName
Add or replace a WAN circuit
/api/networks/:networkId/wan-circuits/:wanCircuitName
Update a WAN circuit
/api/networks/:networkId/wan-circuits/:wanCircuitName
Remove a WAN circuit
/api/networks/:networkId/wan-circuits/:wanCircuitName