Topology

Topology
Topology

The graph representation of a network topology, consisting of entities (nodes) and connections (edges) between them.

JSON Example
{
    "id": "string",
    "entities": [
        {
            "association_count": 0,
            "id": "string",
            "reference_id": "string",
            "name": "string",
            "last_updated_time": 0,
            "entity_type": "string",
            "total_incoming_connections": 0,
            "total_outgoing_connections": 0,
            "config_events": [
                {
                    "event_time": 0
                }
            ],
            "fw_properties": {
                "ew_allowed": 0,
                "ew_blocked": 0,
                "ew_unmicrosegmented": 0,
                "ew_vds": 0
            },
            "highlight": false,
            "state": "string"
        }
    ],
    "connections": {
        "flow_connections": [
            {
                "from": "string",
                "to": "string",
                "fw_properties": {
                    "ew_allowed": 0,
                    "ew_blocked": 0,
                    "ew_unmicrosegmented": 0,
                    "ew_vds": 0
                },
                "flow_properties": {
                    "l4_info": [
                        "string"
                    ],
                    "l7_info": [
                        "string"
                    ]
                }
            }
        ]
    },
    "partial_result": [
        "string"
    ],
    "uuid_mapping": {
        "uuid_mapping": "string"
    },
    "has_uuid_mapping": false,
    "has_communities": false,
    "communities": [
        {
            "association_count": 0,
            "id": "string",
            "reference_id": "string",
            "name": "string",
            "last_updated_time": 0,
            "entity_type": "string",
            "total_incoming_connections": 0,
            "total_outgoing_connections": 0,
            "config_events": [
                {
                    "event_time": 0
                }
            ],
            "fw_properties": {
                "ew_allowed": 0,
                "ew_blocked": 0,
                "ew_unmicrosegmented": 0,
                "ew_vds": 0
            },
            "highlight": false,
            "state": "string",
            "cluster_type": "string",
            "members": [
                "string"
            ],
            "no_flows_entities": 0,
            "allowed_entities": 0,
            "blocked_entities": 0,
            "unmicrosegmented_entities": 0,
            "vds_entities": 0
        }
    ],
    "community_connections": {
        "community_connections": [
            {
                "from": "string",
                "to": "string",
                "fw_properties": {
                    "ew_allowed": 0,
                    "ew_blocked": 0,
                    "ew_unmicrosegmented": 0,
                    "ew_vds": 0
                },
                "flow_properties": {
                    "l4_info": [
                        "string"
                    ],
                    "l7_info": [
                        "string"
                    ]
                }
            }
        ]
    },
    "topology_token": "string"
}
string
id
Optional

ID of topology.

array of Entity
entities
Optional

Array of Entity objects representing the nodes in the network graph.

connections
Optional

Wrapper object containing an array of Connection objects, representing all the network flow relationships (edges) in a topology graph.

partial_result
Required  

Array indicating if the result is incomplete due to scale limits (e.g., UNIQUE_FLOW_THRESHOLD_EXCEEDED).

object
uuid_mapping
Optional

Map from UUIDs in entities/connections to short numeric strings, used to deduplicate and compress the payload.

boolean
has_uuid_mapping
Optional

Indicate if the result has uuid mappings.

boolean
has_communities
Optional

Boolean to indicate if the result contains communities. This is. set when the Graph topology has more nodes. For handling scale we will first return communities.

communities
Optional

An array of CommunityEntity objects.

community_connections
Optional

An array of Connection objects, representing all the network flow relationships (edges) between Communities in a topology graph.

string
topology_token
Read-Only  

Token used to track the topology returned in the response. This token is required for subsequent drill-down requests, such as the /groups-flow-topology/other-members API.

Property Of