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

Update DHCP settings on a specific appliance

post
http://127.0.0.1:8080/dhcpConfig/dhcpSettings

Pushes DHCP configuration settings (mode, server pool, relay) to the specified appliance. The configuration is sent directly to the appliance and an audit log entry is created on success.

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

Body Params

DHCP settings configuration keyed by interface name. Each interface contains mode, server pool, and relay settings.

DHCP settings request details

<interface_name>
object
required
Responses

401

Authentication required. No valid session or token provided.

403

Insufficient permissions. Requires READ_WRITE role.

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?