HomeGuidesAPI ReferenceChangelog
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Get all tunnels between appliances

Use this API to get all the tunnels between a list of appliances. For all physical tunnels, set overlayId to 0. For all bonded tunnels, set overlayId to 'all'. For a specific overlay, you can set overlayId to the overlay ID

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

The max number of tunnels to return

string

Match the tunnel's alias on a text string

string

The overlay ID to match tunnels on. 0 would be all physical tunnels, all - would be all bonded tunnels

string

The regular expression to match a tunnel state

Body Params

List of appliance IDs to retrieve the tunnels between all of them

string
string
Response

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