Get tunnels between appliances

post

http://127.0.0.1:8080/tunnels2/getTunnelsBetweenAppliances

Retrieves all tunnel connections between a list of appliances from cache. Returns physical tunnels (overlayId=0), bonded tunnels (overlayId='all' or specific ID), or pass-through tunnels based on parameters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

limit

integer

≥ 1

Maximum number of tunnels to return. Limits the result set size for pagination or performance optimization.

matchingAlias

string

Filter tunnels by alias using case-insensitive substring matching. Only tunnels containing this text in their alias are returned.

overlayId

string

enum

Filter by overlay type: '0' for physical tunnels only, 'all' for all bonded tunnels, or a specific overlay ID integer for tunnels in that overlay.

Allowed:

includePassThrough

boolean

Defaults to false

Include pass-through tunnels in results. Only effective when overlayId is null or '0'. Pass-through tunnels connect to third-party services.

state

string

Regex pattern to filter tunnels by operational state. Matches against tunnel 'oper' status (e.g., 'Up', 'Down').

Body Params

List of appliance IDs (nePks) to query tunnels between. Tunnels are returned where both source and destination are in this list.

Request body containing the list of appliance identifiers.

nePks

array of objects

required

List of appliance identifiers (nePks).

nePks*

Responses

401

Unauthorized - Valid authentication credentials required.

403

Forbidden - User lacks READ or READ_WRITE permission.

Language

Loading…

Response

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

application/json

200Successfully retrieved tunnel list. Returns an array of tunnel objects matching the filter criteria.

400Bad request due to invalid parameters or malformed request body.