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

Get DHCP failover state information for an appliance

get
http://127.0.0.1:8080/dhcpConfig/state/failover

Retrieves DHCP failover state information for a specific appliance. Failover state includes primary/secondary server status, communication timestamps, and maximum client lead time (MCLT). Data can be retrieved from Orchestrator cache (faster) or fetched directly from the appliance (current). The response format follows ISC DHCP server failover state specification.

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' or omitted, returns cached failover state from Orchestrator. When 'false', fetches fresh data directly from the appliance.

Allowed:
Responses

401

Unauthorized - User lacks READ or READ_WRITE permission.

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?