HomeGuidesAPI ReferenceChangelog
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Search pass through tunnels

This API will return all the matching tunnels given the query parameters. Please use the 'limit' parameter to ensure the response is not too big.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The appliance's id/nePk

string

The ID of the pass through tunnel

string

Search for all tunnels that have this string in it's alias

string

Search for all tunnels that have this string in it's Peer/service

number
required

The max number of tunnels to return

string

The regular expression to match a tunnel state

boolean

The bonded tunnel id

boolean

he alias, this is the name of the tunnel used in the user interface

boolean

The overlay name for the bonded tunnel

boolean

The nePk of the appliance that this bonded tunnel belongs to

boolean

The nePk of the destination appliance for this tunnel

boolean

The tunnel id of the opposite tunnel on the destination appliance

boolean

The tunnel alias of the opposite tunnel on the destination appliance

boolean

The current status of the tunnel

boolean

The admin status of the tunnel

boolean

Remote tunnel id state

boolean

The FEC status of the tunnel

boolean

The FEC ratio

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*