Skip to navigation
ServicesDHCP ServiceDHCP API

Get Lease

View as MarkdownOpen in Claude
Return one normalized lease from the selected DHCP service.

Authentication

AuthorizationBearer

Bearer JWT used by CLI and machine clients on svc-* endpoints. Authentication is required by default, but deployments may disable it with [auth] required = false. Browser OIDC sessions, mTLS, SPIFFE identities, and trusted gateway identity headers may also satisfy authentication outside this generated client flow.

Path parameters

ip_addressstringRequiredformat: "ipvanyaddress"

Query parameters

ip_versionenum or nullOptional
Supported DHCP address families.
Allowed values:

Response

Successful Response
clttinteger
expires_atdatetime or null
ip_addressstringformat: "ipvanyaddress"
stateinteger
valid_lftinteger
client_idstring or nullOptional
duidstring or nullOptional
hostnamestringOptionalDefaults to
hw_addressstring or nullOptional
subnetstring or nullOptional

Errors

404
Not Found Error
422
Unprocessable Entity Error