Export Group Flow Details

Start a CSV export of group flow records

Initiates an asynchronous job to generate a downloadable CSV file containing unique (deduplicated) flow records for the specified group. Unlike POST /visualization/flow-analysis/groups/{group-id}/flow-details, the export produces one row per unique flow without expanding across group memberships.

Notes:

Returns 202 Accepted immediately. The export runs asynchronously -- do not call this endpoint in a loop.
Poll GET /visualization/flow-exports/exports/{export-id} using the export_id from the response until status is COMPLETED.
Once complete, call POST /visualization/flow-exports/exports/{export-id}/get-download-key to obtain the download URL.
file_name is required (1-255 characters) and sets the name of the generated CSV file.
group-id is the NSX group realization UUID. Obtain valid IDs from POST /visualization/topology/groups-flow-topology.
Set expand_external_traffic to true to expand aggregated external traffic rows into individual rows per source and destination IP. Defaults to false.

Request

URI

POST

https://{api_host}/intelligence/visualization/flow-exports/groups/{group-id}/flow-details/export

COPY

Path Parameters

string

group-id

Required

Realization ID of the target group.

Request Body

Wrapper request for GroupsIdFlowDetailsExport with restricted filter keys

VizGroupsIdFlowDetailsExportRequest of type(s) application/json

Required

This request body class requires all of the following: VizGroupsIdFlowDetailsRequest , InlineVizGroupsIdFlowDetailsExportRequest1

{
    "start_time": 1781824044614,
    "site_id": "2996d590-1afe-49a1-905b-3f39b8228da7",
    "file_name": "groupflows1.csv",
    "filters": [
        {
            "filter_type": "EQUAL",
            "filter_key": "FLOW_STATUS",
            "value": [
                "COMPLETED"
            ]
        }
    ]
}

Authentication

This operation uses the following authentication methods.

Responses

202

success

Returns AsyncApiResponse of type(s) application/json

{
    "id": "4efe28ed-d08e-4adc-9edf-7a9617c1771e"
}

string

Optional

UUID identifier of the response.

string

status_url

Optional

The URL to check the status of the operation.

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-exports/groups/{group-id}/flow-details/export

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

202 Response Body

Errors

Security Explorer Operations

POST

Get App Flow Details