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

Get DHCP lease information for an appliance

get
http://127.0.0.1:8080/dhcpConfig/leases

Retrieves DHCP lease records for a specific appliance. Lease data includes IP assignments, MAC addresses, lease times, and state information. Data can be retrieved from Orchestrator cache (faster) or fetched directly from the appliance (current). Lease file format follows ISC DHCP server specification (http://linux.die.net/man/5/dhcpd.leases).

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

Data source selector. When 'true', returns cached lease data from Orchestrator. When 'false', fetches fresh data directly from the appliance.

Allowed:
integer
≥ 1

Maximum number of lease records to return. Only applies when cached=false. When cached=true, returns all cached leases.

Responses

401

Unauthorized - User lacks READ or READ_WRITE permission.

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?