Get Group Flow Connections

Get Group Flow Connections
Get flow records between two groups

Returns a paginated list of flow records between a specific pair of groups. Flows are first deduplicated by the 4-tuple of source VM, destination VM, destination port, and protocol. Each unique flow is then expanded across the cross-product of source and destination group memberships -- only rows where the source group matches source_id and the destination group matches destination_id are returned.

Notes:

  • start_time, src_site_id, dst_site_id, source_id, and destination_id are all required.
  • source_id and destination_id are the NSX group realization UUIDs. Obtain them from POST /visualization/topology/groups-flow-topology.
  • src_site_id and dst_site_id scope the query to the source and destination sites. For intra-site flows, set both to the same site ID.
  • Set bidirectional to true to include flows in both directions. Defaults to false (source -> destination only).
  • filters accepts up to 300 filter entries.
  • To check whether any flows exist between two groups before fetching full details, use the lightweight POST /visualization/flow-analysis/group-connections/flow-type endpoint first.
Request
URI
POST
https://{api_host}/intelligence/visualization/flow-analysis/group-connections
COPY
Request Body

Wrapper request for GroupConnections with restricted filter keys

VizGroupConnectionsRequest of type(s) application/json
Required  
This request body class requires all of the following: VizTimeIntervalListSiteConnectionRequest , InlineVizGroupConnectionsRequest1 
{
    "start_time": 1782170399106,
    "page_size": 50,
    "offset": 0,
    "source_id": "2368d02d-bf5a-4920-b869-719c366d3864",
    "destination_id": "7b321641-2beb-44f6-9181-7f8a4b4d94a0",
    "bidirectional": true,
    "src_site_id": "17f7c7e5-7f8c-490a-97e9-b9c9193c45e1",
    "dst_site_id": "17f7c7e5-7f8c-490a-97e9-b9c9193c45e1"
}
Authentication
This operation uses the following authentication methods.
Responses
200

success

Returns FlowConnectionListResult of type(s) application/json
This response body class contains all of the following: VizTimeIntervalListResult , InlineFlowConnectionListResult1 
{
    "offset": 0,
    "number_of_results": 24,
    "total_result_count": 24,
    "total_pages": 1,
    "time_interval": {
        "start_time": 1782170399106,
        "end_time": 1782171906524
    },
    "results": [
        {
            "source": {
                "groups": [
                    {
                        "id": "7b321641-2beb-44f6-9181-7f8a4b4d94a0",
                        "display_name": "R1_Z1_env11_app61_T1",
                        "reference_id": "/infra/domains/default/groups/bb421784-ef8a-344f-b9d2-b72556afa076"
                    }
                ],
                "compute": {
                    "entity_type": "COMPUTE",
                    "compute_type": "VM",
                    "id": "503beb13-6b17-13c4-2ad8-4ef19e111de9",
                    "reference_id": "503beb13-6b17-13c4-2ad8-4ef19e111de9",
                    "name": "nano_vm1_clone_7560",
                    "config_events": [],
                    "highlight": false
                },
                "apps": [],
                "flow_type": "UN_MICROSEGMENTED",
                "rules": [
                    {
                        "id": "2"
                    }
                ],
                "jump_to_rules": []
            },
            "destination": {
                "groups": [
                    {
                        "id": "2368d02d-bf5a-4920-b869-719c366d3864",
                        "display_name": "R1_Z1_env32",
                        "reference_id": "/infra/domains/default/groups/25c93e59-e9c4-3be9-818b-8498548da8c9"
                    }
                ],
                "compute": {
                    "entity_type": "COMPUTE",
                    "compute_type": "VM",
                    "id": "503bb635-b47e-87e3-0a29-2d9896ad6cad",
                    "reference_id": "503bb635-b47e-87e3-0a29-2d9896ad6cad",
                    "name": "nano_vm1_clone_1681",
                    "config_events": [],
                    "highlight": false
                },
                "apps": [],
                "configured_services": [
                    "Service-TCP-20"
                ],
                "protocol": "TCP",
                "port": 20,
                "flow_type": "UN_MICROSEGMENTED",
                "rules": [
                    {
                        "id": "2"
                    }
                ],
                "jump_to_rules": []
            },
            "flow_info": {
                "last_session_start_time": 1782171247,
                "last_session_end_time": 1782171324,
                "flow_type": "UN_MICROSEGMENTED",
                "is_active": false
            }
        },
        {
            "source": {
                "groups": [
                    {
                        "id": "7b321641-2beb-44f6-9181-7f8a4b4d94a0",
                        "display_name": "R1_Z1_env11_app61_T1",
                        "reference_id": "/infra/domains/default/groups/bb421784-ef8a-344f-b9d2-b72556afa076"
                    }
                ],
                "compute": {
                    "entity_type": "COMPUTE",
                    "compute_type": "VM",
                    "id": "503b7ac7-9607-93bb-be67-78fd60fe1f58",
                    "reference_id": "503b7ac7-9607-93bb-be67-78fd60fe1f58",
                    "name": "nano_vm5_clone_7568",
                    "config_events": [],
                    "highlight": false
                },
                "apps": [],
                "flow_type": "ALLOWED",
                "rules": [
                    {
                        "id": "2"
                    }
                ],
                "jump_to_rules": [
                    {
                        "id": "196673"
                    }
                ]
            },
            "destination": {
                "groups": [
                    {
                        "id": "2368d02d-bf5a-4920-b869-719c366d3864",
                        "display_name": "R1_Z1_env32",
                        "reference_id": "/infra/domains/default/groups/25c93e59-e9c4-3be9-818b-8498548da8c9"
                    }
                ],
                "compute": {
                    "entity_type": "COMPUTE",
                    "compute_type": "VM",
                    "id": "503b886b-0640-8a75-a2ef-1a2ed98022cc",
                    "reference_id": "503b886b-0640-8a75-a2ef-1a2ed98022cc",
                    "name": "nano_vm7_clone_5856",
                    "config_events": [],
                    "highlight": false
                },
                "apps": [],
                "configured_services": [
                    "SSH",
                    "vCentre Operations Standard 1.x",
                    "vCentre Operations Manager (vApp) 5.x"
                ],
                "protocol": "TCP",
                "port": 22,
                "flow_type": "ALLOWED",
                "rules": [
                    {
                        "id": "2"
                    }
                ],
                "jump_to_rules": [
                    {
                        "id": "196673"
                    }
                ]
            },
            "flow_info": {
                "last_session_start_time": 1782171364,
                "last_session_end_time": 1782171336,
                "flow_type": "ALLOWED",
                "is_active": false
            }
        }
    ]
}

400

Bad Request

Returns BadRequest of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


401

Unauthorized

Returns Unauthorized of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


403

Forbidden

Returns Forbidden of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


412

Precondition Failed

Returns PreconditionFailed of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


428

Precondition Required

Returns PreconditionRequired of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


429

Too Many Requests

Returns TooManyRequests of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


default

Error

Returns Error of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/intelligence/visualization/flow-analysis/group-connections
On This Page
Security Explorer Operations
POST
Get App Flow Details
POST
Export App Flow Details
POST
Get App Related Rules
POST
Get Group Related Dfw Rules
POST
Get Group Related Ids Rules
POST
Get Computes Related Rule Counts
POST
Get Groups Related Rule Counts
POST
Get Apps Flow Topology
POST
Get Compute Flow Connections
POST
Get Compute Flow Connections Flow Type
POST
Get Computes Flow Topology
POST
Query Compute Flow Details
POST
Get Compute Flow Details
POST
Export Compute Flow Details
POST
Get Compute Related Ids Rules
POST
Get Compute Related Rules
POST
Get Compute Related Info
POST
Get Environment Pair Flow Details
POST
Export Environment Pair Flow Details
POST
Query Flow Export Jobs
GET
Get Flow Export Job
DELETE
Delete Flow Export Job
PUT
Update Flow Export Job
POST
Get Group Flow Connections
POST
Get Group Flow Connections Flow Type
POST
Get Groups Flow Topology
POST
Fetch Groups Topology Other Members
POST
Get Pinned Group Flow Topology
POST
Get Group Flow Details
POST
Export Group Flow Details
POST
Query Workloads Affected
POST
Get Compute Related Ids Signatures
POST
Get Ids Signature Events History
POST
Get Infra Monitoring Flow Details
POST
Get Infra Monitoring Leaked Flow Details
POST
Export Infra Monitoring Leaked Flow Details
POST
Export Infra Monitoring Flow Details
POST
Get Export Job Download Key