Reserve a subnet in the DHCP pool

post

http://127.0.0.1:8080/dhcpConfig/reservations

Reserves a subnet in the global DHCP pool for a specific appliance interface. The system automatically assigns an available IP address from the pool based on the requested subnet mask. The reservation is marked as source=2 (GMS/Orchestrator). The action is logged to the system action log for audit purposes.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

nePk

string

^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE'). When omitted, results are returned for all appliances.

Body Params

Reservation request specifying subnet mask, appliance identifier, and interface name. The IP address is auto-assigned from available pool space.

Request body for creating a DHCP pool subnet reservation. The IP address is automatically assigned from the pool.

ifName

string

LAN interface name on the appliance (e.g., 'lan0', 'lan1'). Identifies which interface the reservation is for.

mask

number

0 to 32

Defaults to 32

CIDR subnet mask for the reservation (e.g., 24 for /24 = 256 IPs, 25 for /25 = 128 IPs). Range: 0-32.

serialNum

string

Appliance serial number. Used as appliance identifier when nePk query parameter is not provided.

startIp

string

Optional starting IP address. If provided, attempts to reserve from this IP. If omitted, system auto-assigns from available pool space.

Responses

401

Unauthorized - User lacks READ_WRITE permission to create DHCP reservations.

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Subnet reserved successfully. Returns the reservation with auto-assigned IP address from available pool space.

400Bad Request - Invalid reservation data or parameters.

500Internal Server Error - Failed to process reservation due to database or pool calculation error.