HomeGuidesAPI Reference
API Reference

Get physical tunnel state for multiple appliances

Retrieves the current operational state of all physical tunnels for multiple appliances. Returns live tunnel data directly from appliances (not cached). Use the state query parameter to filter results by operational status.

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

Regex pattern to filter tunnels by operational state (e.g., 'Up', 'Down', 'Up - Active'). Case-insensitive matching is applied.

Body Params

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

Request body containing list of appliance identifiers.

nePks
array of objects
required

List of appliance identifiers (nePks).

nePks*
Responses

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