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

Retrieve bonded tunnel states in batch

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

Retrieves the operational state of multiple bonded tunnels in a single batch request. Use this endpoint for efficient bulk retrieval of tunnel states instead of individual requests. Supports both cached (GMS database) and live (direct appliance) data sources.

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

Data source flag. When 'true', retrieves from GMS cache. When 'false' or omitted, retrieves directly from the appliance.

Allowed:
Body Params

List of bonded tunnel IDs. Each ID corresponds to a specific bonded tunnel on the appliance.

Array of tunnel IDs to retrieve states for.

Responses

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

Did this page help you?