Get Network Topology properties (Deprecated)

deprecated

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

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• topologyInfo object

  Topology Object

  extendedProperties string

  An XML string for additional settings

  topologyType integer

  Possible values: [1, 2, 3, 4, 5]

  Type of the topology

  description string

  Topology description

  isSmartTopology boolean

  A boolean flag if the topology contains a smart client group

  firewallGroups object[]

  Firewall groups in the topology

  fwGroupType integer

  Possible values: [1, 2, 3, 4]

  isMnemonic boolean

  True if the group is of a smart clientgroup

  clientGroup object

  Client group object - Pass either name or ID

  clientGroupName string

  Name of the clientGroup

  clientGroupId integer

  ID of the client group

  options object

  Additional settings of the firewall group

  configureAutomatically boolean

  Flag if the options has to be set automatically

  tunnelConnectionPort integer

  Edit Tunnel connection port of clients in the client group

  keepAliveSeconds integer

  Edit the KeepAliveSeconds interval in seconds of the clients in

  topologyEntity object

  topologyName string

  Name 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
  }
}

Loading...