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

Update DHCP reservation configuration

post
http://127.0.0.1:8080/dhcpConfig/reservation

Creates or updates a DHCP static IP reservation on the specified appliance, binding a MAC address to a fixed IP address. Validates the IP and MAC address formats before posting to the appliance.

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

Appliance identifier assigned by Orchestrator (e.g., '0.NE'). Required — returns 400 if missing or empty.

Body Params

DHCP reservation entry with device name, IP address, and MAC address. Both ip and mac fields are validated if provided.

DHCP static IP reservation binding a MAC address to a fixed IP for a specific device.

string

Friendly name identifying the device with the reservation.

string

Reserved IPv4 address assigned to the device. Must be a valid IP address.

string

MAC address of the device in colon-separated hex format (e.g., '00:1A:2B:3C:4D:5E').

Responses

401

Unauthorized — user is not authenticated.

403

Forbidden — user lacks READ_WRITE role.

Updated about 14 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 14 hours ago

Did this page help you?