HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. bondedTunnelsConfiguration

Get bonded tunnel state from multiple appliances

post
http://127.0.0.1:8080/tunnels/bonded/state

Retrieves the current operational state of bonded tunnels from multiple appliances. Returns tunnel state data including operational status, bandwidth, MTU, IPsec health, and uptime. Use the optional state query parameter to filter tunnels by operational status using case-insensitive pattern matching.

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

Filter tunnels by operational state. Uses case-insensitive regex pattern matching against the 'oper' field. Common values: 'Up', 'Down', 'Active'.

Body Params

List of appliance primary keys (nePks) to retrieve bonded tunnel state from.

Request body containing list of appliance identifiers.

nePks
array of objects
required

List of appliance identifiers (nePks).

nePks*
Responses

401

Unauthorized - Authentication required or insufficient permissions.

500

Internal Server Error - Failed to retrieve tunnel state from appliances.

Updated about 12 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 12 hours ago

Did this page help you?