HomeGuidesAPI Reference
API Reference

Gets all Zscaler Tunnels with IP SLA's status of the appliance. The response contains <nePk_labelId>, <connectionStatus> map.

Retrieves the real-time connection status of all Zscaler third-party tunnels configured on the specified appliance. The status is determined using IP SLA (Service Level Agreement) monitoring which tracks the health of each tunnel.

Connection Status Values:

  • Up: Both primary and secondary tunnels (if configured) are operational
  • Down: All configured tunnels are not operational
  • 1 of 2 Up: Only one of the two configured tunnels is operational (partial connectivity)
  • Deleting: The tunnel configuration is being removed
  • Appliance Unreachable: Unable to communicate with the appliance to determine tunnel status

Response Structure:
The response is a key-value map where:

  • Key: Composite identifier in format <nePk>_<labelId> representing the appliance and interface
  • Value: One of the connection status values listed above

Use Cases:

  • Monitor Zscaler tunnel health for specific appliances
  • Detect partial connectivity issues (1 of 2 tunnels up)
  • Identify unreachable appliances in the network
  • Track tunnel deletion progress
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE').

string

Optional interface label filter. This parameter exists in the API but is currently not utilized in the implementation. Tunnel status is returned for all configured Zscaler interfaces on the specified appliance regardless of this parameter.

Responses

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