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

Get DHCP service status

get
http://127.0.0.1:8080/dhcpConfig/service

Retrieves the DHCP server service status (running or stopped) from the specified appliance. By default reads from cache; falls back to a direct appliance query if cached data is empty.

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.

string
enum
Defaults to true

When omitted or 'true', reads from Orchestrator cache first; falls back to a direct appliance query if the cache is empty. Set to 'false' to always query the appliance directly.

Allowed:
Responses

401

Unauthorized — user is not authenticated.

403

Forbidden — user lacks READ or READ_WRITE role.

404

Appliance not found or unreachable.

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?