Search and retrieve pass-through tunnels

get

http://127.0.0.1:8080/tunnels2/passThrough

Retrieves pass-through tunnel configurations from the Orchestrator cache. Supports three query modes: (1) No nePk/tunnelId returns all tunnels grouped by appliance, (2) nePk only returns tunnels for that appliance, (3) nePk + tunnelId returns a specific tunnel. Field selector parameters (id, alias, tag, etc.) limit response fields when set to true.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

nePk

string

^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE'). When omitted, results are returned for all appliances.

tunnelId

string

Specific pass-through tunnel ID. Must be used with nePk to retrieve a single tunnel.

matchingAlias

string

Case-insensitive substring filter for tunnel alias. Returns tunnels where alias contains this string.

matchingService

string

Case-insensitive substring filter for tunnel peer/service name. Returns tunnels where peerName contains this string.

limit

integer

≥ 1

Defaults to 100

Maximum number of tunnels to return. Default is 100 when nePk is provided. Use to limit response size.

state

string

Regex pattern to filter tunnels by operational status (operStatus). Case-insensitive matching.

boolean

Defaults to false

When true, include only the 'id' field in response objects. Used for field selection.

alias

boolean

Defaults to false

When true, include only the 'alias' field in response objects. The alias is the tunnel name shown in the UI.

tag

boolean

Defaults to false

When true, include only the 'tag' field in response objects. The tag is the internal overlay name for the tunnel.

srcNePk

boolean

Defaults to false

When true, include only the 'srcNePk' field in response objects. Identifies the source appliance.

destNePk

boolean

Defaults to false

When true, include only the 'destNePk' field in response objects. Identifies the destination appliance (if applicable).

destTunnelId

boolean

Defaults to false

When true, include only the 'destTunnelId' field in response objects.

destTunnelAlias

boolean

Defaults to false

When true, include only the 'destTunnelAlias' field in response objects.

operStatus

boolean

Defaults to false

When true, include only the 'operStatus' field in response objects. Shows current operational state (Up/Down).

adminStatus

boolean

Defaults to false

When true, include only the 'adminStatus' field in response objects. Shows administrative state.

remoteIdState

boolean

Defaults to false

When true, include only the 'remoteIdState' field in response objects.

fecStatus

boolean

Defaults to false

When true, include only the 'fecStatus' field in response objects. Shows Forward Error Correction status.

fecRatio

boolean

Defaults to false

When true, include only the 'fecRatio' field in response objects. Shows FEC ratio value.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

*/*

200Successful response. Returns pass-through tunnels based on query parameters.

400Bad request - invalid query parameter combination

429Too Many Requests - Rate limit exceeded. Please retry after the specified time.

defaultUnexpected error