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

Get DHCP remote subnets (address pools)

get
http://127.0.0.1:8080/dhcpConfig/remoteSubnets

Retrieves the DHCP address pool configuration for remote subnets on the specified appliance. Returns subnet, gateway, IP ranges, lease times, DNS/NTP/NetBIOS servers. If cached data is unavailable or empty, automatically falls back to querying the appliance directly.

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

Whether to retrieve data from cache or directly from the appliance. Defaults to cache with automatic fallback to appliance if cached data is empty.

Allowed:
Responses

401

Authentication required. No valid session or token provided.

403

Insufficient permissions. Requires READ or READ_WRITE role.

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

Did this page help you?