Skip to main content

Modify Network Topology details

Select

SaaS
Customer Managed

This endpoint is used to edit network topology. Below is the list of required groups for each topology type:

  • 'ONE_WAY': EXTERNAL, INTERNAL.
  • 'TWO_WAY': EXTERNAL, INTERNAL.
  • 'NETWORK_GATEWAY': EXTERNAL, PROXIES, INTERNAL.
  • 'CASCADING_GATEWAYS': EXTERNAL, PROXIES, PROXY_PERIMETER, INTERNAL.
  • 'ONEWAY_FORWARDING': EXTERNAL, PROXIES, INTERNAL.
  • 'TRI_CASCADING_GATEWAYS': EXTERNAL, PROXIES, PROXY2, PROXY_PERIMETER, INTERNAL.
  • 'QUAD_CASCADING_GATEWAYS': EXTERNAL, PROXIES, PROXY2, PROXY3, PROXY_PERIMETER, INTERNAL.
Path Parameters
  • topologyId string required
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, TRI_CASCADING_GATEWAYS, QUAD_CASCADING_GATEWAYS]

    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 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.

Responses

Success


Schema
  • errorMessage string
  • errorCode int32
Loading...