Get Pinned Group Flow Topology

Get group topology centered on a specific (pinned) group

Returns a topology graph centered on the specified group ("pinned" group), showing every other group it communicates with and the flow connections between them.

Notes:

start_time is required. Either site_id or site_ids must also be provided.
The pinned group is marked with pinned: true in the response nodes.
Use entity_limit to cap the number of neighbor group nodes returned.
filters accepts up to 300 filter entries.
Obtain group-id from the nodes returned by POST /visualization/topology/groups-flow-topology.
The group-id is the NSX realization UUID of the group.
Use any group-id from the response nodes to call this endpoint recursively and explore neighboring group neighborhoods.
To see flow records for the pinned group, use POST /visualization/flow-analysis/groups/{group-id}/flow-details. To see its associated DFW rules, use POST /visualization/security-analysis/groups/{group-id}/related-dfw-rules.

Request

URI

POST

https://{api_host}/intelligence/visualization/topology/groups-flow-topology/{group-id}

COPY

Path Parameters

string

group-id

Required

The NSX group realization ID of the group to pin. Obtain valid IDs from POST /visualization/topology/groups-flow-topology, where each node represents a group and carries its ID.

Request Body

Wrapper request for GroupsFlowTopologyId with restricted filter keys

VizGroupsFlowTopologyIdRequest of type(s) application/json

Required

This request body class requires all of the following: VizFlowsTopologyRequest , InlineVizGroupsFlowTopologyIdRequest1

{
    "start_time": 0,
    "site_id": "17f7c7e5-7f8c-490a-97e9-b9c9193c45e1",
    "entity_limit": 5,
    "filters": [],
    "cluster_info": {
        "cluster_type": "FLOW"
    }
}

Authentication

This operation uses the following authentication methods.

Responses

200

success

Returns TopologyResponse of type(s) application/json

{
    "time_interval": {
        "start_time": 0,
        "end_time": 1782176808297
    },
    "topology": {
        "partial_result": [],
        "entities": [
            {
                "entity_type": "GROUP",
                "association_count": 720,
                "id": "79f1fbd6-e3a7-4aec-b5b8-92b36833d7c0",
                "reference_id": "/infra/domains/default/groups/0dad89c7-0401-335e-9f46-1d6a9465e578",
                "name": "R1_Z1_env4",
                "config_events": [
                    {
                        "event_type": "ADDED",
                        "event_time": 1781688055494
                    },
                    {
                        "event_type": "DELETED",
                        "event_time": 0
                    }
                ],
                "highlight": false,
                "members": [],
                "pinned": true
            }
        ],
        "connections": {
            "flow_connections": []
        },
        "uuid_mapping": {},
        "has_communities": false,
        "communities": []
    }
}

object

time_interval

Optional

Represents a continuous span of time defined by a required start and end timestamp.

object

topology

Optional

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

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/topology/groups-flow-topology/{group-id}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Security Explorer Operations

POST

Get App Flow Details