HomeGuidesAPI Reference
API Reference

Get tunnel-related deployment information for appliances

Retrieves deployment mode and network interface information from Orchestrator's in-memory cache. Used for tunnel configuration context. When nePk is omitted, returns data for all appliances keyed by nePk. When nePk is provided, returns data for that appliance with key '0'. Requires 'read' or 'read-write' role.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE'). When omitted, results are returned for all appliances.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Authentication required. No valid session.

403

Insufficient permissions. Requires 'read' or 'read-write' role.

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