OpenAPI 3.0HTTPS Port 906713 Operations • 82 Schemas
Jagornet DHCP Server REST API
Manage live server configuration, stream active DHCPv4/v6 leases, inspect HA peer status, and scrape Prometheus metrics over TLS on default port 9067 (alongside gRPC control channels on port 9066).
Authentication
Lease Inventory & Streaming
Operation Details
- Operation ID:
getDhcpLease - Response Format:
application/json
Parameters
| Name | Location | Type | Required |
|---|---|---|---|
ipaddress | path | string | Yes |
Sample cURL Invocation
curl -k -u jagornet:<password> -X GET "https://10.0.0.10:9067/dhcpleases/10.0.0.100"Server Configuration & Links
HA Status & Prometheus Telemetry
Core Configuration & Filter Schemas
DhcpServerConfig
- v4ServerIdOptionV4ServerIdOption
- v6ServerIdOptionV6ServerIdOption
- policiesPoliciesType
- v4ConfigOptionsV4ConfigOptionsType
- v6MsgConfigOptionsV6ConfigOptionsType
- v6IaNaConfigOptionsV6ConfigOptionsType
- v6NaAddrConfigOptionsV6ConfigOptionsType
- v6IaTaConfigOptionsV6ConfigOptionsType
- v6TaAddrConfigOptionsV6ConfigOptionsType
- v6IaPdConfigOptionsV6ConfigOptionsType
Link
- namestring
- addressstring
- v4ServerIdOptionV4ServerIdOption
- v6ServerIdOptionV6ServerIdOption
- policiesPoliciesType
- v4ConfigOptionsV4ConfigOptionsType
- v4AddrPoolsV4AddressPoolsType
- v4AddrBindingsV4AddressBindingsType
- v6MsgConfigOptionsV6ConfigOptionsType
- v6IaNaConfigOptionsV6ConfigOptionsType
Filter
- namestring
- filterExpressionsFilterExpressionsType
- policiesPoliciesType
- v4ConfigOptionsV4ConfigOptionsType
- v6MsgConfigOptionsV6ConfigOptionsType
- v6IaNaConfigOptionsV6ConfigOptionsType
- v6NaAddrConfigOptionsV6ConfigOptionsType
- v6IaTaConfigOptionsV6ConfigOptionsType
- v6TaAddrConfigOptionsV6ConfigOptionsType
- v6IaPdConfigOptionsV6ConfigOptionsType
FilterExpression
- clientClassExpressionClientClassExpression
- optionExpressionOptionExpression
- customExpressionstring
Credentials
- usernamestring
- passwordstring
GenericOptionsType
- optionDefListOptionDefType[]