HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. appliance

Modify appliance settings via passthrough API

post
http://127.0.0.1:8080/appliance/rest

Proxies a POST request directly to a specified appliance API endpoint. Orchestrator forwards the request to the target appliance's REST API with optional data conversion based on appliance version. Audit logging is performed for most operations except read-like endpoints.

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/'. Leading '/' is optional and will be stripped. May include query parameters after '?'.

Body Params

JSON payload to send to the appliance API. Content is logged for audit purposes (truncated at max log characters). Sensitive data APIs do not log request body.

Configuration data specific to the target appliance API endpoint

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 12 hours ago

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

Updated about 12 hours ago

Did this page help you?