Get Network Topology Details

Select

SaaS

Customer Managed

This endpoint is used to return the detail of network topology.

Path Parameters

• topologyId string required

Responses

• 200
• 404

---

Success

application/json

• Schema
• Example (from schema)

---

Schema

• topologyDetails object

  topology object

  id int32

  name string

  topologyType firewallTopologyTypes

  Possible values: [NETWORK_GATEWAY, ONE_WAY, TWO_WAY, CASCADING_GATEWAYS, ONEWAY_FORWARDING, TRI_CASCADING_GATEWAYS, QUAD_CASCADING_GATEWAYS]

  The type of topology of client groups (and sometimes network gateway) for this instance.

  clientType firewallClientType

  Possible values: [SERVER, LAPTOP]

  The type of clients associated with the topology.

  useWildCardProxy boolean

  Flag determining wether network gateways are used to connect all infrastructure machines

  firewallGroups object[]

  groupType FirewallFwGroupType

  Possible values: [INTERNAL, EXTERNAL, PROXIES, PROXY_PERIMETER, PROXY2, PROXY3]

  A FirewallFwGroupType defines a specific group type within a topology payload.

  clientGroupId int32

  The id of the client group

  mnemonic FirewallGroupMnemonic

  Possible values: [MY_COMMSERVE, MY_MEDIAAGENTS, MY_COMMSERVE_AND_MEDIAAGENTS, NONE]

  Custom names(mnemonics) given to pre-defined smart client groups

  advancedOptions object

  tunnelPort int32

  The port defined for communications

  keepAliveInterval int32

  The interval in seconds for sending keep-alive packets, to maintain the session if backup traffic has an extended pause.

  encryptTraffic boolean

  Flag determining if we want the data from tunnel to use HTTPS protocol

  tunnelProtocol FirewallTopologyTunnelProtocol

  Possible values: [REGULAR, ENCRYPTED, AUTHENTICATED, RAW]

  The protocol for outgoing communication

  tunnelsPerRoute int32

  The number of tunnel connections per route

{
  "topologyDetails": {
    "topology": {
      "id": 0,
      "name": "string"
    },
    "topologyType": "NETWORK_GATEWAY",
    "clientType": "SERVER",
    "useWildCardProxy": true,
    "firewallGroups": [
      {
        "groupType": "INTERNAL",
        "clientGroupId": 0,
        "mnemonic": "MY_COMMSERVE",
        "advancedOptions": {
          "tunnelPort": 0,
          "keepAliveInterval": 0
        }
      }
    ],
    "encryptTraffic": true,
    "tunnelProtocol": "REGULAR",
    "tunnelsPerRoute": 0
  }
}

Requested Details not found

GET /v4/networktopology/:topologyid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

topologyId — path required

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/NetworkTopology/:topologyId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/NetworkTopology/:topologyId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/NetworkTopology/:topologyId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/NetworkTopology/:topologyId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/NetworkTopology/:topologyId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/NetworkTopology/:topologyId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/NetworkTopology/:topologyId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'