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

Retrieve batch of physical tunnel configurations

post
http://127.0.0.1:8080/tunnels/physical/config/getBatch

Retrieves a batch of physical tunnel configurations for specified tunnel IDs. Use cached=true for faster responses from GMS database, or cached=false to query the appliance directly for real-time data. 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').

string
enum
Defaults to false

Data source selection. When 'true', retrieves from GMS cache (faster). When 'false', queries the appliance directly (real-time data).

Allowed:
Body Params

List of tunnel IDs to retrieve. Tunnel IDs can be obtained from GET /tunnels/physical/tunnelIds endpoint.

Array of tunnel identifiers to retrieve configurations 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?