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

Get DHCP settings for a specific appliance

get
http://127.0.0.1:8080/dhcpConfig/dhcpSettings

Retrieves DHCP configuration settings (mode, server pool, relay) for each LAN interface on the specified appliance. Data can be fetched from the Orchestrator cache or directly from the appliance.

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
enum
Defaults to true

If "true" or omitted, returns cached data from Orchestrator. Falls back to a direct appliance query if cache is empty. Set to "false" to always query the appliance directly.

Allowed:
Responses

401

Authentication required. No valid session or token provided.

403

Insufficient permissions. Requires READ or READ_WRITE role.

404

Appliance not found or no cached data available and appliance unreachable.

500

Internal error while retrieving DHCP settings from the appliance.

Updated about 11 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

Updated about 11 hours ago

Did this page help you?