HomeGuidesAPI Reference
API Reference

Retrieve appliance data via passthrough API

Proxies a GET request directly to a specified appliance API endpoint. This passthrough endpoint allows Orchestrator to fetch data from appliance REST APIs with minimal performance overhead. Response data may be converted based on appliance version.

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
required

Appliance API path relative to '/rest/json/'. Use 'shaper' to call '/rest/json/shaper'. May include query parameters after '?'.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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