Export App Flow Details

Start a CSV export of application flow records

Initiates an asynchronous job to generate a downloadable CSV file containing the same unique (deduplicated) flow records as POST /visualization/flow-analysis/applications/{app-id}/flow-details for the specified application.

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 GET /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.
Set expand_external_traffic to true to expand aggregated external traffic rows into individual rows per source and destination IP. Defaults to false.
Obtain app-id from the topology graph returned by POST /visualization/topology/apps-flow-topology or from the inventory API for segmentation object.

Request

URI

POST

https://{api_host}/intelligence/visualization/flow-exports/applications/{app-id}/flow-details/export

COPY

Path Parameters

string

app-id

Required

The NSX application group ID. Obtain valid IDs from POST /visualization/topology/apps-flow-topology, where each node in the topology graph represents an application and carries its ID.

Request Body

Wrapper request for ApplicationsIdFlowDetailsExport with restricted filter keys

VizApplicationsIdFlowDetailsExportRequest of type(s) application/json

Required

This request body class requires all of the following: VizApplicationsIdFlowDetailsRequest , InlineVizApplicationsIdFlowDetailsExportRequest1

{
    "site_id": "2996d590-1afe-49a1-905b-3f39b8228da7",
    "start_time": 1781808046480,
    "file_name": "appflows2.csv",
    "app_request_type": [],
    "use_latest_apps": true
}

Authentication

This operation uses the following authentication methods.

Responses

202

success

Returns AsyncApiResponse of type(s) application/json

{
    "id": "79e4c262-8140-4e39-9af8-fa03cc3f2e16"
}

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/applications/{app-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