Export Environment Pair Flow Details

Export Environment Pair Flow Details
Start a CSV export of environment-pair flow records

Initiates an asynchronous job to generate a downloadable CSV file containing the same unique (deduplicated) flow records as POST /visualization/flow-analysis/environments/pair-flow-details for a pair of environments.

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.
  • 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/environments/pair-flow-details/export
COPY
Request Body

Wrapper request for EnvironmentsPairFlowDetailsExport with restricted filter keys

VizEnvironmentsPairFlowDetailsExportRequest of type(s) application/json
Required  
This request body class requires all of the following: VizEnvironmentsPairFlowDetailsRequest , InlineVizEnvironmentsPairFlowDetailsExportRequest1 
{
    "start_time": 0,
    "src_site_id": "17f7c7e5-7f8c-490a-97e9-b9c9193c45e1",
    "dst_site_id": "17f7c7e5-7f8c-490a-97e9-b9c9193c45e1",
    "src_env_id": "d108367c-9ae3-4b0b-98c7-61ec7c72be6f",
    "dst_env_id": "2cda03cc-4713-44d8-adda-8a0c45b7863c",
    "file_name": "env-pair-flows.csv",
    "env_request_type": "ALL",
    "expand_external_traffic": false
}
Authentication
This operation uses the following authentication methods.
Responses
202

success

Returns AsyncApiResponse of type(s) application/json 
{
    "id": "f8c48c42-c50d-40af-8df4-aadb07bf2a67"
}
string
id
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/environments/pair-flow-details/export
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