Get bonded tunnels configuration

get

http://127.0.0.1:8080/tunnels2/bonded

Retrieves bonded tunnel configurations from the Orchestrator cache. Supports three query modes: (1) No nePk/tunnelId - returns all tunnels for all appliances, (2) nePk only - returns all tunnels for a specific appliance, (3) nePk + tunnelId - returns a single tunnel. Use boolean field selectors to return only specific fields. Use 'limit' parameter to control result size.

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

Filter by specific tunnel ID. Must be used with nePk to retrieve a single tunnel.

limit

integer

≥ 1

Maximum number of bonded tunnels to return. Use this to limit results as networks may have many tunnels.

matchingAlias

string

Case-insensitive partial match filter for tunnel alias names.

overlayId

string

Filter by overlay ID. Use 'all' to return tunnels from all overlays, or a specific numeric ID.

state

string

Regex pattern to filter tunnels by operational status (e.g., 'Up', 'Down'). Case-insensitive.

boolean

Defaults to false

When true, includes only the 'id' field in response objects.

alias

boolean

Defaults to false

When true, includes only the 'alias' field (tunnel display name) in response objects.

tag

boolean

Defaults to false

When true, includes only the 'tag' field (overlay name) in response objects.

srcNePk

boolean

Defaults to false

When true, includes only the 'srcNePk' field (source appliance ID) in response objects.

destNePk

boolean

Defaults to false

When true, includes only the 'destNePk' field (destination appliance ID) in response objects.

destTunnelId

boolean

Defaults to false

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

destTunnelAlias

boolean

Defaults to false

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

operStatus

boolean

Defaults to false

When true, includes only the 'operStatus' field (operational status like Up/Down) in response objects.

adminStatus

boolean

Defaults to false

When true, includes only the 'adminStatus' field (administrative status) in response objects.

remoteIdState

boolean

Defaults to false

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

fecStatus

boolean

Defaults to false

When true, includes only the 'fecStatus' field (Forward Error Correction status) in response objects.

fecRatio

boolean

Defaults to false

When true, includes only the 'fecRatio' field (FEC ratio value) in response objects.

children

boolean

Defaults to false

When true, includes 'children' array with physical tunnel id/alias pairs for each bonded tunnel.

Responses

Language

Loading…

Response

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

application/json

200Successfully retrieved bonded tunnel configurations from Orchestrator cache.

400Bad Request - Invalid parameter combination