Create a Network Topology
Select
This endpoint is used to create network topology.
- application/json
Request Body
- topologyName string
- clientType firewallClientType
Possible values: [
SERVER
,LAPTOP
]The type of clients associated with the topology.
- topologyType firewallTopologyTypes
Possible values: [
NETWORK_GATEWAY
,ONE_WAY
,TWO_WAY
,CASCADING_GATEWAYS
,ONEWAY_FORWARDING
]The type of topology of client groups (and sometimes network gateway) for this instance.
- tunnelProtocol FirewallTopologyTunnelProtocol
Possible values: [
REGULAR
,ENCRYPTED
,AUTHENTICATED
,RAW
]The protocol for outgoing communication
- tunnelsPerRoute int32
The number of tunnel connections per route
- useWildCardProxy boolean
Flag determining wether network gateways are used to connect all infrastructure machines
- encryptTraffic boolean
Flag determining if we want the data from tunnel to use HTTPS protocol
firewallGroups object[]
groupType FirewallFwGroupTypePossible values: [
INTERNAL
,EXTERNAL
,PROXIES
,PROXY_PERIMETER
]clientGroupId int32The id of the client group
mnemonic FirewallGroupMnemonicPossible values: [
MY_COMMSERVE
,MY_MEDIAAGENTS
,MY_COMMSERVE_AND_MEDIAAGENTS
,NONE
]Custom names(mnemonics) given to pre-defined smart client groups
advancedOptions object
tunnelPort int32The port defined for communications
keepAliveInterval int32The interval in seconds for sending keep-alive packets, to maintain the session if backup traffic has an extended pause.
- 200
- 400
- 500
Success
- application/json
- Schema
- Example (from schema)
Schema
- topologyId integer
error object
errorMessage stringerrorCode int32
{
"topologyId": 0,
"error": {
"errorMessage": "string",
"errorCode": 0
}
}
Bad Request
Internal Server Error