HomeGuidesAPI Reference
API Reference

Retrieve appliance information by nePk or list all accessible appliances

Retrieves appliance information from Orchestrator. When nePk is provided, returns detailed information for a single appliance including HA peer, zones, interfaces, roles, and custom tags. When nePk is omitted, returns a list of all appliances accessible to the authenticated user based on RBAC settings. Password field is always null for security.

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.

Responses

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