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

Retrieve batch of pass-through tunnel states

post
http://127.0.0.1:8080/tunnels/passThrough/state/getBatch

Retrieves the operational state of multiple pass-through (third-party) tunnels in a single batch request. Pass-through tunnels are used for third-party service integrations such as Zscaler. When cached=true, data is retrieved from Orchestrator's cache for faster response. When cached=false, data is fetched directly from the appliance for real-time accuracy.

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 true

Controls data source: 'true' retrieves from Orchestrator cache (faster), 'false' fetches real-time data from the appliance (slower but current).

Allowed:
Body Params

A JSON array containing the tunnel IDs (names) for which to retrieve state information. Only tunnels matching these IDs will be returned in the response.

Array of tunnel IDs to retrieve state information for.

Responses

Updated about 13 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
*/*

Updated about 13 hours ago

Did this page help you?