Get Network Topology properties (Deprecated)
Select
This endpoint has been deprecated and may be removed in future versions of the API.
This operation returns details of a particular network topology.
Path Parameters
- topologyId string required
- 200
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
topologyInfo object
Topology Object
extendedProperties stringAn XML string for additional settings
topologyType integerPossible values: [
1
,2
,3
,4
,5
]Type of the topology
description stringTopology description
isSmartTopology booleanA boolean flag if the topology contains a smart client group
firewallGroups object[]
Firewall groups in the topology
fwGroupType integerPossible values: [
1
,2
,3
,4
]isMnemonic booleanTrue if the group is of a smart clientgroup
clientGroup object
Client group object - Pass either name or ID
clientGroupName stringName of the clientGroup
clientGroupId integerID of the client group
options object
Additional settings of the firewall group
configureAutomatically booleanFlag if the options has to be set automatically
tunnelConnectionPort integerEdit Tunnel connection port of clients in the client group
keepAliveSeconds integerEdit the KeepAliveSeconds interval in seconds of the clients in
topologyEntity object
topologyName stringName of the topology
{
"topologyInfo": {
"extendedProperties": "string",
"topologyType": 1,
"description": "string",
"isSmartTopology": true,
"firewallGroups": [
{
"fwGroupType": 1,
"isMnemonic": true,
"clientGroup": {
"clientGroupName": "string",
"clientGroupId": 0
},
"options": {
"configureAutomatically": true,
"tunnelConnectionPort": 0,
"keepAliveSeconds": 0
}
}
],
"topologyEntity": {
"topologyName": "string"
}
}
}
{
"topologyInfo": {
"extendedProperties": "<App_TopologyExtendedProperties connectionProtocol=\"2\" numberOfStreams=\"1\" displayType=\"0\" encryptTraffic=\"0\"/>",
"topologyType": 3,
"description": "",
"isSmartTopology": true,
"firewallGroups": [
{
"fwGroupType": 2,
"isMnemonic": false,
"clientGroup": {
"_type_": 28,
"clientGroupId": 25
},
"options": {
"useWildcardProxy": false,
"configureAutomatically": true,
"keepAliveSeconds": 100,
"tunnelConnectionPort": 8409
}
},
{
"fwGroupType": 1,
"isMnemonic": true,
"clientGroup": {
"_type_": 28,
"clientGroupId": -1
}
}
],
"topologyEntity": {
"_type_": 156,
"topologyName": "oneway",
"topologyId": 14
}
},
"error": {
"errorCode": 0
}
}