HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. flow

Returns detailed flow information

get
http://127.0.0.1:8080/flow/flowDetails

Retrieves comprehensive flow details including optimization settings, QoS configuration, routing information, and traffic statistics for a specific flow on an appliance. Requires READ or READ_WRITE role permissions.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE').

int64
required
≥ 1

Unique flow identifier. Obtained from the flow list endpoint (/flow).

int64
required
≥ 1

Flow sequence number used to track flow state changes. Obtained from the flow list endpoint.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized - Authentication required or invalid credentials

403

Forbidden - User lacks READ or READ_WRITE role permissions

500

Internal Server Error - Error communicating with the appliance

Updated about 12 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/html

Updated about 12 hours ago

Did this page help you?