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

Save global Orchestrator DHCP configuration settings

post
http://127.0.0.1:8080/dhcpConfig

Saves the global DHCP pool configuration to the Orchestrator database. After saving, it automatically rebuilds the DHCP pool reservations based on deployment cache data. The action is logged to the system action log for audit purposes. This configuration serves as the default for DHCP settings in Deployment Profiles.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Complete DHCP configuration object containing mode, server settings, relay settings, and failover configuration. All fields are optional - unspecified fields retain their default values.

Global DHCP configuration object containing server settings, relay settings, and failover configuration.

dhcpFoSetting
object

Map of DHCP failover settings. Keys are interface names or failover relationship identifiers.

string
enum

Default DHCP mode for appliance interfaces.

Allowed:
relayConfig
object

DHCP relay agent configuration settings.

serverConfig
object

DHCP server configuration including IP pool and lease settings.

Responses
204

DHCP configuration saved successfully. The DHCP pool reservations are automatically rebuilt after saving.

401

Unauthorized - User lacks READ_WRITE permission to modify DHCP configuration.

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

Updated about 12 hours ago

Did this page help you?