Get Group Flow Details

Get Group Flow Details
Get flow records for a specific group

Returns a paginated list of flow records where at least one endpoint belongs to the specified group. Flows are first deduplicated by the 4-tuple of source VM, destination VM, destination port, and protocol. Each unique flow is then expanded across group memberships -- all rows where the specified group appears as either source or destination are returned.

Notes:

  • start_time is required. Either site_id or site_ids must also be provided.
  • parent_id optionally scopes the result to flows where the group belongs to a specific parent group context.
  • pinned_parent_id optionally scopes results to the pinned group view.
  • filters accepts up to 300 filter entries.
  • Obtain group-id from the topology graph returned by POST /visualization/topology/groups-flow-topology, where each node represents a group.
  • To export these results as a CSV file (one row per unique flow, without group expansion), use POST /visualization/flow-exports/groups/{group-id}/flow-details/export.
  • To see the DFW rules associated with this group, use POST /visualization/security-analysis/groups/{group-id}/related-dfw-rules.
  • Example: VM1 belongs to groups G1 and G2; VM2 belongs to groups G2 and G3. A single flow VM1->VM2 on port 443/TCP produces four rows from the cross-product: (G1->G2), (G1->G3), (G2->G2), (G2->G3). Querying for group G2 returns three rows -- (G2->G2), (G2->G3), and (G1->G2) -- because G2 appears as source or destination in each.
Request
URI
POST
https://{api_host}/intelligence/visualization/flow-analysis/groups/{group-id}/flow-details
COPY
Path Parameters
string
group-id
Required  

Realization ID of the target group.

Request Body

Wrapper request for GroupsIdFlowDetails with restricted filter keys

VizGroupsIdFlowDetailsRequest of type(s) application/json
Required  
This request body class requires all of the following: VizTimeIntervalListSiteRequest , InlineVizGroupsIdFlowDetailsRequest1 
{
    "start_time": 1781824044614,
    "page_size": 50,
    "offset": 0,
    "site_id": "2996d590-1afe-49a1-905b-3f39b8228da7",
    "filters": [
        {
            "filter_type": "EQUAL",
            "filter_key": "FLOW_STATUS",
            "value": [
                "COMPLETED"
            ]
        }
    ]
}
Authentication
This operation uses the following authentication methods.
Responses
200

success

Returns FlowDetailListResult of type(s) application/json
This response body class contains all of the following: VizTimeIntervalListResult , InlineFlowDetailListResult1 
{
    "offset": 0,
    "number_of_results": 50,
    "total_result_count": 56,
    "total_pages": 2,
    "time_interval": {
        "start_time": 1781824044614,
        "end_time": 1781825094784
    },
    "results": [
        {
            "source": {
                "groups": [
                    {
                        "id": "045ec911-c26f-4883-a0ab-d0eaffb6025e",
                        "reference_id": "045ec911-c26f-4883-a0ab-d0eaffb6025e"
                    }
                ],
                "compute": {
                    "entity_type": "COMPUTE",
                    "compute_type": "VM",
                    "id": "5032615d-d9c9-8298-2b20-f880a99469bf",
                    "reference_id": "5032615d-d9c9-8298-2b20-f880a99469bf",
                    "name": "inc_1_nesx-node0_vm_2",
                    "config_events": [],
                    "highlight": false
                },
                "apps": [],
                "flow_type": "UN_MICROSEGMENTED",
                "rules": [
                    {
                        "id": "2"
                    }
                ],
                "jump_to_rules": [
                    {
                        "id": "2621"
                    }
                ]
            },
            "destination": {
                "groups": [
                    {
                        "id": "8c39ac2f-7e3a-42f0-b1c8-95b2c1bf7653",
                        "display_name": "Group-1 (REC 260521 09:06:46 - America_us-east_dev_new3)",
                        "reference_id": "/infra/domains/default/groups/Group-e5ca64f0-552a-11f1-a3a4-db2e2bec23bd-eb7d787c-d6f3-4e21-a7d5-67cf6622ba04"
                    }
                ],
                "compute": {
                    "entity_type": "COMPUTE",
                    "compute_type": "VM",
                    "id": "50320eea-6950-e694-5fcd-a8e9454734cf",
                    "reference_id": "50320eea-6950-e694-5fcd-a8e9454734cf",
                    "name": "inc_1_nesx-node3_vm_1",
                    "config_events": [],
                    "highlight": false
                },
                "apps": [],
                "configured_services": [
                    "CIM-HTTP",
                    "vCenter5.x V1",
                    "Win - RPC, DCOM, EPM, DRSUAPI, NetLogonR, SamR, FRS - TCP",
                    "VMware-VDM2.x-Ephemeral",
                    "Vmware View/VDM2.x",
                    "Microsoft Active Directory V1"
                ],
                "protocol": "TCP",
                "port": 5988,
                "flow_type": "UN_MICROSEGMENTED",
                "rules": [
                    {
                        "id": "2"
                    }
                ],
                "jump_to_rules": [
                    {
                        "id": "2621"
                    }
                ]
            },
            "flow_info": {
                "last_session_start_time": 1781824436,
                "last_session_end_time": 1781824741,
                "flow_type": "UN_MICROSEGMENTED",
                "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/groups/{group-id}/flow-details
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