HomeGuidesAPI Reference
API Reference

Get third-party tunnel states from multiple appliances

Retrieves the current operational state of all third-party tunnels from multiple appliances. Returns tunnel state data keyed by appliance primary key, with each appliance containing an 'allTunnelState' map of tunnel names to their state objects. Supports optional filtering by tunnel state using a regex pattern.

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

Regular expression pattern to filter tunnels by operational state. Matches against the 'oper' field using case-insensitive partial matching.

Body Params

Object containing array of appliance primary keys to query for tunnel states.

Request body containing list of appliance identifiers.

nePks
array of objects
required

List of appliance identifiers (nePks).

nePks*
Responses

401

Unauthorized - Authentication required. User must have READ or READ_WRITE role.

403

Forbidden - Insufficient permissions. User lacks READ or READ_WRITE role.

500

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

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