HomeGuidesAPI Reference
API Reference

Retrieve batch of physical tunnel states

Retrieves state information for a batch of physical tunnels on the specified appliance. Use this endpoint to efficiently fetch multiple tunnel states in a single request. When cached=true, returns data from Orchestrator cache; when cached=false (default), queries the appliance directly for real-time state.

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

string
enum
Defaults to false

When 'true', retrieves data from Orchestrator cache. When 'false', fetches directly from the appliance.

Allowed:
Body Params

Array of tunnel IDs to retrieve state information for. Each ID must match an existing tunnel on the target appliance.

Tunnel identifier

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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