HomeGuidesAPI Reference
API Reference

Get deployment configuration for an appliance

Retrieves the full deployment configuration for a specified EdgeConnect appliance. This is the first step of the read-modify-write workflow for changing any deployment setting (interfaces, DHCP, routing, etc.). When cached is true, returns data from Orchestrator's database (faster, may be stale). When cached is false, fetches live data directly from the appliance (slower, always current). Use cached=false when retrieving a config you intend to modify. To apply changes after modifying the returned object, POST the full modified deployment JSON to POST /appliance/rest?nePk={nePk}&url=deployment (see the 'appliance' tag). Key data paths: Interface configs are in modeIfs[].applianceIPs[]. DHCP server config (including DNS servers) is at modeIfs[].applianceIPs[].dhcpd.server.dns. Interface label/zone/vrf fields are numeric IDs — resolve to names via sysConfig.ifLabels, sysConfig.zones, and sysConfig.vrfs. Requires 'read' or 'read-write' role.

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').

boolean
required

When true, retrieves deployment data from Orchestrator's database cache (faster, may be stale). When false, fetches live data directly from the appliance (slower, always current).

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