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

Get flow optimization details

get
http://127.0.0.1:8080/flow/flowOptimization

Returns flow optimization information including optimization action status, warnings, and error messages for a specific flow identified by its ID and sequence number on the target appliance.

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').

integer
required
≥ 0

Flow identifier used to uniquely identify a specific flow on the appliance. Obtain this value from the /flow endpoint.

integer
required
≥ 0

Flow sequence identifier distinguishing between multiple instances of the same flow. Used together with 'id' to uniquely identify a flow.

integer
enum
required
Defaults to 0

Controls whether to suppress or show flow warnings. Set to 1 to ignore warnings, 0 to show warnings.

Allowed:
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 permissions.

Updated about 11 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 11 hours ago

Did this page help you?