How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Forward Networks Synthetic Devices API

Model a network’s internet connections, intranets, L2VPNs, L3VPNs, WAN circuits, and encryptors

Forward Networks Synthetic Devices API is one of 20 APIs that Forward Networks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Synthetic Devices. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 45 operations across 15 paths, and defines 27 schemas. It is described by OpenAPI 3.2.0, at version 26.6.

Requests are made against a single base URL, /api.

45 operations 15 paths 27 schemas 9 DELETE15 GET6 PATCH4 POST11 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
26.6
Base URL
https://fwd.app/api
Authentication
HTTP Basic
License
Resource Areas
1

Authentication & Security 1

Forward Networks Synthetic Devices API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (api_token).

Paths & Operations 45

Across 15 paths, the API surfaces 45 operations — 9 DELETE, 15 GET, 6 PATCH, 4 POST, 11 PUT. Each is listed below with its method, path, parameters, and response codes.

Synthetic Devices 45

Model a network’s internet connections, intranets, L2VPNs, L3VPNs, WAN circuits, and encryptors

GET
/networks/{networkId}/encryptors
Get a network's encryptors
getEncryptors 1 param → 200
PUT
/networks/{networkId}/encryptors
Replace all of a network’s encryptors
putEncryptors 1 param body → 204
GET
/networks/{networkId}/encryptors/{deviceName}
Get an encryptor
getEncryptor 2 params → 200
PUT
/networks/{networkId}/encryptors/{deviceName}
Add or replace an encryptor
putEncryptor 2 params body → 204
PATCH
/networks/{networkId}/encryptors/{deviceName}
Update an encryptor
patchEncryptor 2 params body → 200
DELETE
/networks/{networkId}/encryptors/{deviceName}
Remove an encryptor
deleteEncryptor 2 params → 204
GET
/networks/{networkId}/internet-node
Get the network’s internet node
getInternetNode 1 param → 200
PUT
/networks/{networkId}/internet-node
Replace the network’s internet node
putInternetNode 1 param body → 204
PATCH
/networks/{networkId}/internet-node
Update the network’s internet node
updateInternetNode 1 param body → 200
GET
/networks/{networkId}/internet-node/connections
Get the internet node’s connections
getInternetNodeConnections 6 params → 200
POST
/networks/{networkId}/internet-node/connections
Add a connection to the internet node
addInternetNodeConnection 1 param body → 204
DELETE
/networks/{networkId}/internet-node/connections
Remove internet node connections
deleteInternetNodeConnections 6 params → 200
GET
/networks/{networkId}/intranet-nodes
Get a network’s intranet nodes
getIntranetNodes 1 param → 200
PUT
/networks/{networkId}/intranet-nodes
Replace all of a network’s intranet nodes
putIntranetNodes 1 param body → 204
GET
/networks/{networkId}/intranet-nodes/{nodeName}
Get an intranet node
getIntranetNode 2 params → 200
PUT
/networks/{networkId}/intranet-nodes/{nodeName}
Add or replace an intranet node
putIntranetNode 2 params body → 204
PATCH
/networks/{networkId}/intranet-nodes/{nodeName}
Update an intranet node
patchIntranetNode 2 params body → 200
DELETE
/networks/{networkId}/intranet-nodes/{nodeName}
Remove an intranet node
deleteIntranetNode 2 params → 204
GET
/networks/{networkId}/intranet-nodes/{nodeName}/connections
Get an intranet node’s connections
getIntranetNodeConnections 7 params → 200
POST
/networks/{networkId}/intranet-nodes/{nodeName}/connections
Add a connection to an intranet node
addIntranetNodeConnection 2 params body → 204
DELETE
/networks/{networkId}/intranet-nodes/{nodeName}/connections
Remove an intranet node’s connections
deleteIntranetNodeConnections 7 params → 200
GET
/networks/{networkId}/l2-vpns
Get a network’s L2VPNs
getL2Vpns 1 param → 200
PUT
/networks/{networkId}/l2-vpns
Replace all of a network’s L2VPNs
putL2Vpns 1 param body → 204
GET
/networks/{networkId}/l2-vpns/{l2VpnName}
Get an L2VPN
getL2Vpn 2 params → 200
PUT
/networks/{networkId}/l2-vpns/{l2VpnName}
Add or replace an L2VPN
putL2Vpn 2 params body → 204
PATCH
/networks/{networkId}/l2-vpns/{l2VpnName}
Update an L2VPN
patchL2Vpn 2 params body → 200
DELETE
/networks/{networkId}/l2-vpns/{l2VpnName}
Remove an L2VPN
deleteL2Vpn 2 params → 204
GET
/networks/{networkId}/l2-vpns/{l2VpnName}/connections
Get an L2VPN’s connections
getL2VpnConnections 5 params → 200
POST
/networks/{networkId}/l2-vpns/{l2VpnName}/connections
Add a connection to an L2VPN
addL2VpnConnection 2 params body → 204
DELETE
/networks/{networkId}/l2-vpns/{l2VpnName}/connections
Remove an L2VPN’s connections
deleteL2VpnConnections 5 params → 200
GET
/networks/{networkId}/l3-vpns
Get a network’s L3VPNs
getL3Vpns 1 param → 200
PUT
/networks/{networkId}/l3-vpns
Replace all of a network’s L3VPNs
putL3Vpns 1 param body → 204
GET
/networks/{networkId}/l3-vpns/{l3VpnName}
Get an L3VPN
getL3Vpn 2 params → 200
PUT
/networks/{networkId}/l3-vpns/{l3VpnName}
Add or replace an L3VPN
putL3Vpn 2 params body → 204
PATCH
/networks/{networkId}/l3-vpns/{l3VpnName}
Update an L3VPN
patchL3Vpn 2 params body → 200
DELETE
/networks/{networkId}/l3-vpns/{l3VpnName}
Remove an L3VPN
deleteL3Vpn 2 params → 204
GET
/networks/{networkId}/l3-vpns/{l3VpnName}/connections
Get an L3VPN’s connections
getL3VpnConnections 7 params → 200
POST
/networks/{networkId}/l3-vpns/{l3VpnName}/connections
Add a connection to an L3VPN
addL3VpnConnection 2 params body → 204
DELETE
/networks/{networkId}/l3-vpns/{l3VpnName}/connections
Remove an L3VPN’s connections
deleteL3VpnConnections 7 params → 200
GET
/networks/{networkId}/wan-circuits
Get a network’s WAN circuits
getWanCircuits 1 param → 200
PUT
/networks/{networkId}/wan-circuits
Replace all of a network’s WAN circuits
putWanCircuits 1 param body → 204
GET
/networks/{networkId}/wan-circuits/{wanCircuitName}
Get a WAN circuit
getWanCircuit 2 params → 200
PUT
/networks/{networkId}/wan-circuits/{wanCircuitName}
Add or replace a WAN circuit
putWanCircuit 2 params body → 204
PATCH
/networks/{networkId}/wan-circuits/{wanCircuitName}
Update a WAN circuit
patchWanCircuit 2 params body → 200
DELETE
/networks/{networkId}/wan-circuits/{wanCircuitName}
Remove a WAN circuit
deleteWanCircuit 2 params → 204

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are L3SyntheticWanConnection (11 properties), Encryptor (5 properties), EncryptorPatch (5 properties), EncryptorConnection (4 properties). Each schema is shown below with its type and property counts.

WanCircuit
object
3 properties 3 required
IntranetNodePatch
object
2 properties
EncryptorPatch
object
5 properties
InternetNodePatch
object
4 properties
SyntheticNatEntry
object
2 properties 2 required
L3VpnPatch
object
2 properties
AutoDiscoverySource
string
IntranetNodeList
object
1 property 1 required
IntranetNode
object
2 properties 2 required
EncryptorTunnel
object
2 properties 2 required
Encryptor
object
5 properties 3 required
L2Vpn
object
2 properties 2 required
SyntheticConnections
object
1 property
WanCircuitList
object
1 property
SyntheticConnection
object
1 property
L3SyntheticWanConnection
object
11 properties 1 required
L2VpnPatch
object
2 properties
L2VpnList
object
1 property 1 required
EncryptorConnection
object
4 properties 1 required
WanCircuitPatch
object
3 properties
WanCircuitConnection
object
4 properties 2 required
InternetNode
object
4 properties 2 required
L3Vpn
object
2 properties 2 required
L2VpnConnection
object
4 properties 2 required
DevicePort
object
2 properties
EncryptorList
object
1 property 1 required
L3VpnList
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

forward-networks-synthetic-devices-api-openapi.yml Raw ↑

Other APIs Forward Networks publishes across the network.

Forward Networks Aliases API
Forward Networks Checks API
Forward Networks Classic Devices API
Forward Networks Credentials API
Forward Networks Current Version API
Forward Networks Device Tags API
Forward Networks Jump Servers API
Forward Networks Network Collection API
Forward Networks Network Devices API
Forward Networks Network Endpoints API
Forward Networks Network Locations API
Forward Networks Network Snapshots API
Where this information came from

This is an independent, third-party profile of Forward Networks Synthetic Devices API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.