Search physical tunnels across appliances

get

http://127.0.0.1:8080/tunnels2/physical

Retrieves physical tunnel configurations from the Orchestrator cache. Supports three query modes: (1) All tunnels across all appliances when no filters provided, (2) All tunnels for a specific appliance when only nePk provided, (3) A specific tunnel when both nePk and tunnelId provided. Boolean field selector parameters (id, alias, tag, etc.) control which fields appear in the response - if any are true, only those fields are returned.

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

Tunnel identifier. When combined with nePk, returns a specific tunnel. Ignored if nePk is not provided.

limit

integer

≥ 1

Maximum number of tunnels to return. Applied when iterating through all appliances or a single appliance's tunnels.

matchingAlias

string

Case-insensitive substring match on tunnel alias. Filters tunnels whose alias contains this string.

state

string

Regex pattern to match tunnel operational status (operStatus). Case-insensitive matching is applied.

boolean

Defaults to false

Include only the 'id' field in response when true. Used for selective field retrieval.

alias

boolean

Defaults to false

Include only the 'alias' field (tunnel display name) in response when true.

tag

boolean

Defaults to false

Include only the 'tag' field (overlay name) in response when true.

srcNePk

boolean

Defaults to false

Include only the 'srcNePk' field (source appliance nePk) in response when true.

destNePk

boolean

Defaults to false

Include only the 'destNePk' field (destination appliance nePk) in response when true.

destTunnelId

boolean

Defaults to false

Include only the 'destTunnelId' field (remote tunnel ID) in response when true.

destTunnelAlias

boolean

Defaults to false

Include only the 'destTunnelAlias' field (remote tunnel alias) in response when true.

operStatus

boolean

Defaults to false

Include only the 'operStatus' field (current operational state) in response when true.

adminStatus

boolean

Defaults to false

Include only the 'adminStatus' field (administrative state) in response when true.

remoteIdState

boolean

Defaults to false

Include only the 'remoteIdState' field in response when true.

fecStatus

boolean

Defaults to false

Include only the 'fecStatus' field (Forward Error Correction status) in response when true.

fecRatio

boolean

Defaults to false

Include only the 'fecRatio' field (FEC ratio value) in response when true.

Responses

Language

Loading…

Response

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

application/json

200Physical tunnel data retrieved successfully. Response structure varies based on query parameters.

400Bad Request - Invalid query parameters